📖 Classes

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 123]

▼NCZ
▼CRCore	Library entry point and global context
COptions	Options used to initialize RCore
▼CRDevice	A rendering device
CCaps	Device capabilities
CRDMABufferInfo	Description of a DMA-BUF backed buffer
CRDrawImageInfo	Describes how to draw an image (or a portion of it) onto an RSurface's viewport
CRDRMFdHandle	A DRM device file descriptor paired with arbitrary user data
CRDRMFormat	A DRM Four Character Code format along with a set of supported modifiers
CRDRMFormatSet	Represents a set of DRM formats and their associated modifiers
CRDRMFramebuffer	A DRM framebuffer usable for KMS scanout
CRDRMPlatformHandle	Platform handle for the DRM platform
CRDRMTimeline	A DRM synchronization object (syncobj) timeline for explicit synchronization
CRDumbBuffer	A DRM dumb buffer for software (CPU) rendering
CREGLClientExtensions	Availability flags for EGL client (display-independent) extensions
CREGLClientProcs	Client-level EGL function pointers resolved via eglGetProcAddress
CREGLDeviceExtensions	Availability flags for EGL extensions queried per EGLDeviceEXT
CREGLDisplayExtensions	Availability flags for EGL extensions queried per EGLDisplay
CREGLDisplayProcs	Display-level EGL/GL function pointers resolved for a given EGLDisplay
CREGLImage	Wraps an EGLImage imported from a dma-buf, exposing it to the OpenGL backend
CREGLSurfaceInfo	Describes an existing EGLSurface to wrap as an RGLImage
CRFormatInfo	Describes the memory layout properties of a DRM pixel format
CRGammaLUT	Gamma LUT
CRGBMBo	Wrapper around a native GBM buffer object (gbm_bo)
CRGLContextData	Context-specific user data
CRGLContextDataManager	OpenGL context data manager
CRGLCore	OpenGL backend implementation of RCore
CRGLDevice	OpenGL backend implementation of RDevice
CRGLExtensions	Availability flags for the OpenGL ES extensions used by the GL backend
CRGLFormat	OpenGL ES pixel format descriptor mapped from a DRM format
CRGLFramebufferInfo	Describes an existing OpenGL framebuffer object to wrap as an RGLImage
CRGLImage	OpenGL backend implementation of RImage
CRGLMakeCurrent	RAII guard for scoped eglMakeCurrent() calls
CRGLPainter	OpenGL backend implementation of RPainter
CRGLPass	OpenGL backend implementation of RPass
▼CRGLProgram	A linked OpenGL ES program (vertex + fragment shader) for a given feature set
CLocations	Cached locations of the program's vertex attributes and uniforms
CRGLShader	A compiled OpenGL ES shader specialized for a set of features
CRGLStrings	OpenGL/EGL string helpers
CRGLSwapchainWL	OpenGL backend implementation of RWLSwapchain
CRGLSync	OpenGL backend implementation of RSync
CRGLTexture	A reference to an OpenGL ES texture object
CRImage	A GPU-accessible image buffer
CRImageConstraints	Constraints applied when allocating an RImage
CRLockGuard	RAII guard that serializes access to Ream's global lock
CRMatrixUtils	Helpers for building the coordinate-space transformation matrices used during rendering
CRObject	Base class for Ream objects
CROFPlatformHandle	Platform handle for the Offscreen platform
▼CRPainter	High-performance built-in renderer
CState	Snapshot of the painter's mutable rendering state
CRPass	A Ream render pass
CRPixelBufferInfo	Describes a pixel buffer
CRPixelBufferRegion	Describes a region to be copied from/to a pixel buffer
CRPlatformHandle	Abstract handle to the underlying windowing/display platform
CRRSCore	Raster (software) implementation of RCore
CRRSDevice	Raster (software) implementation of RDevice
CRRSImage	Raster (software) implementation of RImage
CRRSPainter	Raster (software) implementation of RPainter
CRRSPass	Raster (software) implementation of RPass
CRRSSwapchainWL	Raster (software) implementation of RWLSwapchain
CRSurface	Abstraction for rendering into an RImage
CRSurfaceGeometry	Describes the coordinate mapping of an RSurface
CRSwapchain	Abstract base class representing a rendering swapchain
CRSwapchainImage	An image acquired from an RSwapchain
CRSync	GPU/CPU synchronization fence
CRVKCore	Vulkan implementation of RCore, obtained via RCore::asVK()
CRVKDevice	Vulkan backend implementation of RDevice
CRVKDeviceExtensions	Availability flags for the optional device extensions/features Ream uses
CRVKDeviceProcs	Device-level function pointers resolved via vkGetDeviceProcAddr
CRVKImage	Vulkan implementation of RImage, obtained via RImage::asVK()
CRVKInstanceProcs	Instance-level function pointers resolved via vkGetInstanceProcAddr
CRVKPainter	Vulkan implementation of RPainter (native SPIR-V shaders)
CRVKPass	Vulkan render pass
CRVKPipeline	Device-owned cache of Vulkan render passes, pipelines, layouts, and samplers used by RVKPainter. Shared across all passes on the device
CRVKSwapchainWL	Wayland-client Vulkan swapchain (VK_KHR_wayland_surface + VkSwapchainKHR)
CRVKSync	Vulkan RSync represented by a sync_file fd
CRWLFormat	Helper for converting between DRM pixel formats and Wayland wl_shm formats
CRWLPlatformHandle	Wayland platform handle
CRWLSubpixel	Helper for converting between Ream (RSubpixel) and Wayland (wl_output_subpixel) subpixel layouts
CRWLSwapchain	Abstract swapchain that presents to a Wayland client surface