SRM
v0.10.0-1
Simple Rendering Manager
|
OpenGL texture shared across GPUs. More...
OpenGL texture shared across GPUs.
An SRMBuffer encapsulates an OpenGL ES 2.0 texture that is shared across multiple GPUs. It can be created from a variety of sources including DMA planes, main memory, GBM bo buffers, and more. This module provides functions to manage and use such shared textures.
Enumerations | |
enum | SRM_BUFFER_CAP |
Enumerates the capabilities of an SRMBuffer. More... | |
enum | SRM_BUFFER_SRC |
Enumerates the possible sources of an SRMBuffer. More... | |
Functions | |
SRMBuffer * | srmBufferCreateFromGBM (SRMCore *core, struct gbm_bo *bo) |
Creates an SRMBuffer from a GBM bo. More... | |
SRMBuffer * | srmBufferCreateFromDMA (SRMCore *core, SRMDevice *allocator, SRMBufferDMAData *dmaPlanes) |
Creates an SRMBuffer from Direct Memory Access (DMA) planes. More... | |
SRMBuffer * | srmBufferCreateFromCPU (SRMCore *core, SRMDevice *allocator, UInt32 width, UInt32 height, UInt32 stride, const void *pixels, SRM_BUFFER_FORMAT format) |
Creates an SRMBuffer from main memory buffer. More... | |
SRMBuffer * | srmBufferCreateFromWaylandDRM (SRMCore *core, void *wlBuffer) |
Creates an SRMBuffer from a Wayland wl_drm buffer. More... | |
SRMBuffer * | srmBufferCreateGLTextureWrapper (SRMDevice *device, GLuint id, GLenum target, SRM_BUFFER_FORMAT format, UInt32 width, UInt32 height, UInt8 transferOwnership) |
Creates a wrapper for an already created OpenGL texture. More... | |
void | srmBufferDestroy (SRMBuffer *buffer) |
Destroys an SRMBuffer. More... | |
GLuint | srmBufferGetTextureID (SRMDevice *device, SRMBuffer *buffer) |
Retrieves an OpenGL texture ID associated with an SRMBuffer for a specific device (GPU). More... | |
GLenum | srmBufferGetTextureTarget (SRMBuffer *buffer) |
Gets the OpenGL texture target associated with an SRMBuffer. More... | |
EGLImage | srmBufferGetEGLImage (SRMDevice *device, SRMBuffer *buffer) |
Gets an EGLImage associated with a specific device. More... | |
UInt8 | srmBufferWrite (SRMBuffer *buffer, UInt32 stride, UInt32 dstX, UInt32 dstY, UInt32 dstWidth, UInt32 dstHeight, const void *pixels) |
Writes pixel data to an SRMBuffer. More... | |
UInt8 | srmBufferRead (SRMBuffer *buffer, Int32 srcX, Int32 srcY, Int32 srcW, Int32 srcH, Int32 dstX, Int32 dstY, Int32 dstStride, UInt8 *dstBuffer) |
Reads pixel data from an SRMBuffer. More... | |
UInt32 | srmBufferGetWidth (SRMBuffer *buffer) |
Retrieves the width of an SRMBuffer. More... | |
UInt32 | srmBufferGetHeight (SRMBuffer *buffer) |
Retrieves the height of an SRMBuffer. More... | |
SRM_BUFFER_FORMAT | srmBufferGetFormat (SRMBuffer *buffer) |
Retrieves the format of an SRMBuffer. More... | |
SRMDevice * | srmBufferGetAllocatorDevice (SRMBuffer *buffer) |
Retrieves the allocator device associated with an SRMBuffer. More... | |
typedef struct SRMBufferStruct SRMBuffer |
enum SRM_BUFFER_CAP |
Enumerates the capabilities of an SRMBuffer.
Enumerator | |
---|---|
SRM_BUFFER_CAP_READ | Capability to read from the buffer. |
SRM_BUFFER_CAP_WRITE | Capability to write to the buffer. |
SRM_BUFFER_CAP_MAP | Capability to map the buffer. |
enum SRM_BUFFER_SRC |
Enumerates the possible sources of an SRMBuffer.
Creates an SRMBuffer from a GBM bo.
This function creates an SRMBuffer object using the provided Generic Buffer Management (GBM) buffer object.
struct gbm_bo
must remain valid during the buffer lifetime. It is not destroyed when the buffer is destroyed and must be destroyed manually.core | Pointer to the SRMCore instance. |
bo | Pointer to the GBM buffer object. |
NULL
on failure. SRMBuffer* srmBufferCreateFromDMA | ( | SRMCore * | core, |
SRMDevice * | allocator, | ||
SRMBufferDMAData * | dmaPlanes | ||
) |
Creates an SRMBuffer from Direct Memory Access (DMA) planes.
This function creates an SRMBuffer object using the provided DMA planes data, which includes information about width, height, format, stride of planes, and more.
core | Pointer to the SRMCore instance. |
allocator | Pointer to the SRMDevice responsible for memory allocation. Use NULL to enable texture sharing across all devices (GPUs). |
dmaPlanes | Pointer to the SRMBufferDMAData containing DMA planes data. |
NULL
is passed as the allocator device, srmCoreGetAllocatorDevice() is used.NULL
on failure. SRMBuffer* srmBufferCreateFromCPU | ( | SRMCore * | core, |
SRMDevice * | allocator, | ||
UInt32 | width, | ||
UInt32 | height, | ||
UInt32 | stride, | ||
const void * | pixels, | ||
SRM_BUFFER_FORMAT | format | ||
) |
Creates an SRMBuffer from main memory buffer.
This function creates an SRMBuffer object using a main memory buffer, allowing you to define the buffer's width, height, stride, pixel data, and format.
core | Pointer to the SRMCore instance. |
allocator | Pointer to the SRMDevice responsible for memory allocation. Use NULL to enable texture sharing across all devices (GPUs). |
width | Width of the src buffer. |
height | Height of the src buffer. |
stride | Stride (row pitch) of the src buffer in bytes. |
pixels | Pointer to the pixel data. |
format | Format of the pixel data. |
NULL
is passed as the allocator device, srmCoreGetAllocatorDevice() is used.NULL
on failure. Creates an SRMBuffer from a Wayland wl_drm
buffer.
This function creates an SRMBuffer object using the provided Wayland wl_drm
buffer.
core | Pointer to the SRMCore instance. |
wlBuffer | Pointer to the Wayland DRM buffer. |
NULL
on failure. SRMBuffer* srmBufferCreateGLTextureWrapper | ( | SRMDevice * | device, |
GLuint | id, | ||
GLenum | target, | ||
SRM_BUFFER_FORMAT | format, | ||
UInt32 | width, | ||
UInt32 | height, | ||
UInt8 | transferOwnership | ||
) |
Creates a wrapper for an already created OpenGL texture.
This function allows you to use an existing OpenGL texture within the SRM framework.
device | The SRMDevice whose EGLDisplay was used to create the texture. |
id | The OpenGL texture ID of the existing texture. |
target | The target for the texture (e.g., GL_TEXTURE_2D or GL_TEXTURE_EXTERNAL_OES ). |
format | The DRM format of the texture. |
width | The width of the texture in pixels. |
height | The height of the texture in pixels. |
transferOwnership | If non-zero, the texture will be destroyed when srmBufferDestroy() is called. |
NULL
on failure. void srmBufferDestroy | ( | SRMBuffer * | buffer | ) |
Retrieves an OpenGL texture ID associated with an SRMBuffer for a specific device (GPU).
This function retrieves the OpenGL texture ID that corresponds to the given SRMBuffer for the specified device (GPU).
device | Pointer to the SRMDevice representing the specific device (GPU). |
buffer | Pointer to the SRMBuffer for which the texture ID is requested. |
GLenum srmBufferGetTextureTarget | ( | SRMBuffer * | buffer | ) |
Gets the OpenGL texture target associated with an SRMBuffer.
This function retrieves the OpenGL texture target associated with the provided SRMBuffer.
For textures using the GL_TEXTURE_EXTERNAL_OES
target, rendering requires the utilization of a custom shader, as demonstrated in the following example:
buffer | Pointer to the SRMBuffer for which the texture target is needed. |
GL_TEXTURE_2D
or GL_TEXTURE_EXTERNAL_OES
. Gets an EGLImage
associated with a specific device.
The returned image is owned by the SRMBuffer and should not be destroyed manually.
device | The device whose EGLDisplay is used to create the image. |
buffer | Pointer to the SRMBuffer. |
EGLImage
associated with the SRMDevice or EGL_NO_IMAGE
on failure. UInt8 srmBufferWrite | ( | SRMBuffer * | buffer, |
UInt32 | stride, | ||
UInt32 | dstX, | ||
UInt32 | dstY, | ||
UInt32 | dstWidth, | ||
UInt32 | dstHeight, | ||
const void * | pixels | ||
) |
Writes pixel data to an SRMBuffer.
This function writes pixel data to the specified region of an SRMBuffer.
buffer | Pointer to the SRMBuffer to write data to. |
stride | Stride of the source pixel data. |
dstX | X-coordinate of the top-left corner of the destination region. |
dstY | Y-coordinate of the top-left corner of the destination region. |
dstWidth | Width of the destination region. |
dstHeight | Height of the destination region. |
pixels | Pointer within the source buffer to copy from (not affected by dstX and dstY). |
UInt8 srmBufferRead | ( | SRMBuffer * | buffer, |
Int32 | srcX, | ||
Int32 | srcY, | ||
Int32 | srcW, | ||
Int32 | srcH, | ||
Int32 | dstX, | ||
Int32 | dstY, | ||
Int32 | dstStride, | ||
UInt8 * | dstBuffer | ||
) |
Reads pixel data from an SRMBuffer.
This function reads pixel data from the specified region of an SRMBuffer and copies it to the destination buffer.
glReadPixels()
.buffer | Pointer to the SRMBuffer to read data from. |
srcX | X-coordinate of the top-left corner of the source region. |
srcY | Y-coordinate of the top-left corner of the source region. |
srcW | Width of the source region. |
srcH | Height of the source region. |
dstX | X-coordinate of the top-left corner of the destination region in the destination buffer. |
dstY | Y-coordinate of the top-left corner of the destination region in the destination buffer. |
dstStride | Stride (row pitch) of the destination buffer. |
dstBuffer | Pointer to the destination buffer where the pixel data will be copied. |
SRM_BUFFER_FORMAT srmBufferGetFormat | ( | SRMBuffer * | buffer | ) |
Retrieves the format of an SRMBuffer.
This function retrieves the pixel format of the specified SRMBuffer.
buffer | Pointer to the SRMBuffer. |
Retrieves the allocator device associated with an SRMBuffer.
This function retrieves the SRMDevice responsible for memory allocation associated with the specified SRMBuffer.
buffer | Pointer to the SRMBuffer. |
NULL
on failure.