mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2026-03-12 05:34:35 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

buffer: add more docs

Browse source
This commit is contained in:
Simon Ser 2024-11-04 19:05:38 +01:00
parent ea93dd5cc3
commit 3fdbfb0be8
1 changed files with 13 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/wlr/types/wlr_buffer.h
View file

@ -17,11 +17,15 @@
struct wlr_buffer; struct wlr_buffer;
struct wlr_renderer; struct wlr_renderer;
/**
* Shared-memory attributes for a buffer.
*/
struct wlr_shm_attributes { struct wlr_shm_attributes {
int fd; int fd;
uint32_t format; uint32_t format; // FourCC code, see DRM_FORMAT_* in <drm_fourcc.h>
int width, height, stride; int width, height;
off_t offset; int stride; // Number of bytes between consecutive pixel lines
off_t offset; // Offset in bytes of the first pixel in FD
}; };
/** /**
@ -130,6 +134,12 @@ enum wlr_buffer_data_ptr_access_flag {
*/ */
bool wlr_buffer_begin_data_ptr_access(struct wlr_buffer *buffer, uint32_t flags, bool wlr_buffer_begin_data_ptr_access(struct wlr_buffer *buffer, uint32_t flags,
void **data, uint32_t *format, size_t *stride); void **data, uint32_t *format, size_t *stride);
/**
* Indicate that a pointer to a buffer's underlying memory will no longer be
* used.
*
* This function must be called after wlr_buffer_begin_data_ptr_access().
*/
void wlr_buffer_end_data_ptr_access(struct wlr_buffer *buffer); void wlr_buffer_end_data_ptr_access(struct wlr_buffer *buffer);
/** /**