mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2025-10-29 05:40:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

render/allocator: document struct wlr_allocator

Browse source
This commit is contained in:
Simon Ser 2024-05-07 16:47:50 +02:00 • committed by Kirill Primak
parent f409fcc772
commit 8cd58bc53c
1 changed files with 10 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/wlr/render/allocator.h
View file

@ -25,6 +25,16 @@ struct wlr_allocator_interface {
void wlr_allocator_init(struct wlr_allocator *alloc,
const struct wlr_allocator_interface *impl, uint32_t buffer_caps);
/**
* An allocator is responsible for allocating memory for pixel buffers.
*
* Each allocator may return buffers with different capabilities (shared
* memory, DMA-BUF, memory mapping, etc), placement (main memory, VRAM on a
* GPU, etc) and properties (possible usage, access performance, etc). See
* struct wlr_buffer.
*
* An allocator can be passed to a struct wlr_swapchain for multiple buffering.
*/
struct wlr_allocator {
const struct wlr_allocator_interface *impl;