jp9000
/
obs-studio
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Document gs_texture_create_from_dmabuf 

Add some documentation about this new Linux-only function, and its
characteristics.
master
Georges Basile Stavracas Neto 2021-03-30 11:05:06 -03:00 committed by Jim
parent bde55cbf7b
commit 11e5e6b633
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/sphinx/reference-libobs-graphics-graphics.rst
View File

@ -966,6 +966,34 @@ Texture Functions
---------------------
.. function:: gs_texture_t *gs_texture_create_from_dmabuf(unsigned int width, unsigned int height, uint32_t drm_format, enum gs_color_format color_format, uint32_t n_planes, const int *fds, const uint32_t *strides, const uint32_t *offsets, const uint64_t *modifiers)
**Linux only:** Creates a texture from DMA-BUF metadata.
Exchanging DMA-BUFs is a verbose process because of its multiplanar nature.
For example, YUV can have each plane as a color channel, or a monitor buffer
can have the cursor stored in a separate plane.
This function treats the OBS Studio format and the DRM format separately.
This allows creating textures from DMA-BUFs with unsupported formats (e.g.
YUV) and perform the color format conversion using shaders. However, be
careful to always try and match the formats correctly, otherwise textures
can fail to be created or rendered.
:param width: Width of the texture
:param height: Height of the texture
:param drm_format: DRM format of the DMA-BUF buffer
:param color_format: Color format compatible with OBS Studio
:param n_planes: Number of planes of the DMA-BUF
:param fds: Array of size *n_planes* with the file descriptor of each plane
:param strides: Array of size *n_planes* with the stride of each plane
:param offsets: Array of size *n_planes* with the offset of each plane
:param modifiers: Array of size *n_planes* with the modifier of each plane
:return: A texture object on success, or *NULL* on failure
:rtype: gs_texture_t*
---------------------
.. function:: gs_texture_t *gs_texture_create_from_iosurface(void *iosurf)
**Mac only:** Creates a texture from an IOSurface.