Files
love/src/modules/graphics/opengl/FenceSync.cpp
T
Alex Szpakowski 3a5c3df02f Add sync and async texture and buffer readback APIs.
- Add imagedata = love.graphics.readbackTexture(texture, [slice, mipmap, x, y, w, h, [dest, destx, desty]]).
- Add readback = love.graphics.readbackTextureAsync(texture, [slice, mipmap, x, y, w, h, [dest, destx, desty]]).
- Add bytedata = love.graphics.readbackBuffer(buffer, [offset, size, [dest, destoffset]]).
- Add readback = ove.graphics.readbackBufferAsync(buffer, [offset, size, [dest, destoffset]]).
- Deprecate Texture:newImageData.

The async variants return a new GraphicsReadback object. It has the following methods:
- isComplete()
- hasError()
- wait()
- getBufferData()
- getImageData()
- update() (called automatically every frame by love, not normally needed).

Support notes:
- readbackBuffer and readbackBufferAsync require buffer copying support.
- readbackTexture with a render target (canvas) is always supported. readbackTexture with a non-render-target requires copy-texture-to-buffer support.
- readbackTextureAsync with a render target requires copy-render-target-to-buffer support. readbackTextureAsync with a non-render-target requires copy-texture-to-buffer support.
2022-05-30 21:53:55 -03:00

103 lines
2.0 KiB
C++

/**
* Copyright (c) 2006-2022 LOVE Development Team
*
* This software is provided 'as-is', without any express or implied
* warranty. In no event will the authors be held liable for any damages
* arising from the use of this software.
*
* Permission is granted to anyone to use this software for any purpose,
* including commercial applications, and to alter it and redistribute it
* freely, subject to the following restrictions:
*
* 1. The origin of this software must not be misrepresented; you must not
* claim that you wrote the original software. If you use this software
* in a product, an acknowledgment in the product documentation would be
* appreciated but is not required.
* 2. Altered source versions must be plainly marked as such, and must not be
* misrepresented as being the original software.
* 3. This notice may not be removed or altered from any source distribution.
**/
#include "FenceSync.h"
namespace love
{
namespace graphics
{
namespace opengl
{
FenceSync::~FenceSync()
{
cleanup();
}
bool FenceSync::fence()
{
bool wasActive = sync != 0;
if (wasActive)
cleanup();
sync = glFenceSync(GL_SYNC_GPU_COMMANDS_COMPLETE, 0);
return !wasActive;
}
bool FenceSync::isComplete() const
{
if (sync == 0)
return true;
GLenum status = glClientWaitSync(sync, 0, 0);
if (status == GL_ALREADY_SIGNALED || status == GL_CONDITION_SATISFIED)
return true;
if (status == GL_WAIT_FAILED)
return true;
return false;
}
bool FenceSync::cpuWait()
{
if (sync == 0)
return false;
GLbitfield flags = 0;
GLuint64 duration = 0;
while (true)
{
GLenum status = glClientWaitSync(sync, flags, duration);
if (status == GL_ALREADY_SIGNALED || status == GL_CONDITION_SATISFIED)
break;
if (status == GL_WAIT_FAILED)
break;
flags = GL_SYNC_FLUSH_COMMANDS_BIT;
duration = 1000000000; // 1 second in nanoseconds.
}
cleanup();
return true;
}
void FenceSync::cleanup()
{
if (sync != 0)
{
glDeleteSync(sync);
sync = 0;
}
}
} // opengl
} // graphics
} // love