struct EE::Window::FrameReadback

Overview

Description of caller-owned storage for a framebuffer rectangle readback. More…

#include <window.hpp>

struct FrameReadback {
    // fields

    Uint8* pixels { nullptr };
    Sizei size;
    size_t stride { 0 };
    Vector2i position;
    FramePixelFormat format { FramePixelFormat::RGB24 };
    FrameOrigin origin { FrameOrigin::BottomLeft };
};

Detailed Documentation

Description of caller-owned storage for a framebuffer rectangle readback.

Fields

Uint8* pixels { nullptr }

Destination pixel storage.

Sizei size

Rectangle size in pixels.

size_t stride { 0 }

Destination row stride in bytes.

Vector2i position

Bottom-left framebuffer coordinate of the rectangle.

FramePixelFormat format { FramePixelFormat::RGB24 }

Destination pixel layout.

FrameOrigin origin { FrameOrigin::BottomLeft }

Requested destination row orientation.