Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 43 additions & 4 deletions arcade/gl/framebuffer.py
Original file line number Diff line number Diff line change
Expand Up @@ -428,15 +428,23 @@ def read(
raise ValueError(f"Invalid dtype '{dtype}'")

with self.activate():
# Configure attachment to read from
gl.glReadBuffer(gl.GL_COLOR_ATTACHMENT0 + attachment)
# Configure attachment to read from. Does not work on default framebuffer.
if not self.is_default:
gl.glReadBuffer(gl.GL_COLOR_ATTACHMENT0 + attachment)

gl.glPixelStorei(gl.GL_PACK_ALIGNMENT, 1)
gl.glPixelStorei(gl.GL_UNPACK_ALIGNMENT, 1)

if viewport:
x, y, width, height = viewport
else:
x, y, width, height = 0, 0, self._width, self._height
x, y, width, height = 0, 0, *self.size

data = (gl.GLubyte * (components * component_size * width * height))(0)
gl.glReadPixels(x, y, width, height, base_format, pixel_type, data)
gl.glReadBuffer(gl.GL_COLOR_ATTACHMENT0) # Reset to default

if not self.is_default:
gl.glReadBuffer(gl.GL_COLOR_ATTACHMENT0) # Reset to default

return string_at(data, len(data))

Expand Down Expand Up @@ -571,6 +579,37 @@ def __init__(self, ctx: "Context"):
# HACK: Signal the default framebuffer having depth buffer
self._depth_attachment = True # type: ignore

@property
def size(self) -> Tuple[int, int]:
"""
Size as a ``(w, h)`` tuple

:type: tuple (int, int)
"""
return self._ctx.window.get_framebuffer_size()

@property
def width(self) -> int:
"""
The width of the framebuffer in pixels

:type: int
"""
return self.size[0]

@property
def height(self) -> int:
"""
The height of the framebuffer in pixels

:type: int
"""
return self.size[1]

def _get_framebuffer_size(self) -> Tuple[int, int]:
"""Get the framebuffer size of the window"""
return self._ctx.window.get_framebuffer_size()

def _get_viewport(self) -> Tuple[int, int, int, int]:
"""
Get or set the framebuffer's viewport.
Expand Down
7 changes: 7 additions & 0 deletions tests/unit/gl/test_opengl_framebuffer.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,10 @@ def test_resize(ctx):
fbo.resize()
assert fbo.size == tex.size
assert fbo.viewport == (0, 0, *fbo.size)

def test_read_screen_framebuffer(window):
components = 3
data = window.ctx.screen.read(components=components)
assert isinstance(data, bytes)
w, h = window.get_framebuffer_size()
assert len(data) == w * h * components