.TH "wayland::server::zwp_linux_buffer_params_v1_t" 3 "Wed May 1 2024 17:27:19" "Version 1.0.0" "Wayland++" \" -*- nroff -*- .ad l .nh .SH NAME wayland::server::zwp_linux_buffer_params_v1_t \- parameters for creating a dmabuf-based wl_buffer .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits wayland::server::resource_t\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "std::function< void()> & \fBon_destroy\fP ()" .br .RI "delete this object, used or not " .ti -1c .RI "std::function< void(int, uint32_t, uint32_t, uint32_t, uint32_t, uint32_t)> & \fBon_add\fP ()" .br .RI "add a dmabuf to the temporary set " .ti -1c .RI "std::function< void(int32_t, int32_t, uint32_t, zwp_linux_buffer_params_v1_flags)> & \fBon_create\fP ()" .br .RI "create a wl_buffer from the given dmabufs " .ti -1c .RI "std::function< void(\fBbuffer_t\fP, int32_t, int32_t, uint32_t, zwp_linux_buffer_params_v1_flags)> & \fBon_create_immed\fP ()" .br .RI "immediately create a wl_buffer from the given dmabufs " .ti -1c .RI "void \fBcreated\fP (bool post=true)" .br .RI "buffer creation succeeded " .ti -1c .RI "void \fBfailed\fP (bool post=true)" .br .RI "buffer creation failed " .ti -1c .RI "void \fBpost_already_used\fP (std::string const &msg)" .br .RI "Post error: the dmabuf_batch object has already been used to create a wl_buffer\&. " .ti -1c .RI "void \fBpost_plane_idx\fP (std::string const &msg)" .br .RI "Post error: plane index out of bounds\&. " .ti -1c .RI "void \fBpost_plane_set\fP (std::string const &msg)" .br .RI "Post error: the plane index was already set\&. " .ti -1c .RI "void \fBpost_incomplete\fP (std::string const &msg)" .br .RI "Post error: missing or too many planes to create a buffer\&. " .ti -1c .RI "void \fBpost_invalid_format\fP (std::string const &msg)" .br .RI "Post error: format not supported\&. " .ti -1c .RI "void \fBpost_invalid_dimensions\fP (std::string const &msg)" .br .RI "Post error: invalid width or height\&. " .ti -1c .RI "void \fBpost_out_of_bounds\fP (std::string const &msg)" .br .RI "Post error: offset + stride * height goes out of dmabuf bounds\&. " .ti -1c .RI "void \fBpost_invalid_wl_buffer\fP (std::string const &msg)" .br .RI "Post error: invalid wl_buffer resulted from importing dmabufs via the create_immed request on given buffer_params\&. " .ti -1c .RI "bool \fBproxy_has_object\fP () const" .br .RI "Check whether this wrapper actually wraps an object\&. " .ti -1c .RI "void \fBpost_no_memory\fP () const" .br .ti -1c .RI "uint32_t \fBget_id\fP () const" .br .ti -1c .RI "client_t \fBget_client\fP () const" .br .ti -1c .RI "unsigned int \fBget_version\fP () const" .br .ti -1c .RI "std::string \fBget_class\fP ()" .br .in -1c .SS "Static Public Attributes" .in +1c .ti -1c .RI "static constexpr std::uint32_t \fBcreated_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBcreated\fP function\&. " .ti -1c .RI "static constexpr std::uint32_t \fBfailed_since_version\fP = 1" .br .RI "Minimum protocol version required for the \fBfailed\fP function\&. " .in -1c .SH "Detailed Description" .PP parameters for creating a dmabuf-based wl_buffer This temporary object is a collection of dmabufs and other parameters that together form a single logical buffer\&. The temporary object may eventually create one wl_buffer unless cancelled by destroying it before requesting 'create'\&. .PP Single-planar formats only require one dmabuf, however multi-planar formats may require more than one dmabuf\&. For all formats, an 'add' request must be called once per plane (even if the underlying dmabuf fd is identical)\&. .PP You must use consecutive plane indices ('plane_idx' argument for 'add') from zero to the number of planes used by the drm_fourcc format code\&. All planes required by the format must be given exactly once, but can be given in any order\&. Each plane index can be set only once\&. .PP Definition at line \fB1790\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Member Function Documentation" .PP .SS "void zwp_linux_buffer_params_v1_t::created (bool post = \fCtrue\fP)" .PP buffer creation succeeded .PP \fBReturns\fP .RS 4 the newly created wl_buffer .RE .PP This event indicates that the attempted buffer creation was successful\&. It provides the new wl_buffer referencing the dmabuf(s)\&. .PP Upon receiving this event, the client should destroy the zlinux_dmabuf_params object\&. .PP Definition at line \fB5029\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::failed (bool post = \fCtrue\fP)" .PP buffer creation failed This event indicates that the attempted buffer creation has failed\&. It usually means that one of the dmabuf constraints has not been fulfilled\&. .PP Upon receiving this event, the client should destroy the zlinux_buffer_params object\&. .PP Definition at line \fB5034\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::string wayland::server::resource_t::get_class ()\fC [inherited]\fP" Retrieve the interface name (class) of a resource object\&. .PP \fBReturns\fP .RS 4 Interface name of the resource object\&. .RE .PP .SS "client_t wayland::server::resource_t::get_client () const\fC [inherited]\fP" Get the associated client .PP \fBReturns\fP .RS 4 the client that owns the resource\&. .RE .PP .SS "uint32_t wayland::server::resource_t::get_id () const\fC [inherited]\fP" Get the internal ID of the resource .PP \fBReturns\fP .RS 4 the internal ID of the resource .RE .PP .SS "unsigned int wayland::server::resource_t::get_version () const\fC [inherited]\fP" Get interface version .PP \fBReturns\fP .RS 4 Interface version this resource has been constructed with\&. .RE .PP .SS "std::function< void(int, uint32_t, uint32_t, uint32_t, uint32_t, uint32_t)> & zwp_linux_buffer_params_v1_t::on_add ()" .PP add a dmabuf to the temporary set .PP \fBParameters\fP .RS 4 \fIfd\fP dmabuf fd .br \fIplane_idx\fP plane index .br \fIoffset\fP offset in bytes .br \fIstride\fP stride in bytes .br \fImodifier_hi\fP high 32 bits of layout modifier .br \fImodifier_lo\fP low 32 bits of layout modifier .RE .PP This request adds one dmabuf to the set in this zwp_linux_buffer_params_v1\&. .PP The 64-bit unsigned value combined from modifier_hi and modifier_lo is the dmabuf layout modifier\&. DRM AddFB2 ioctl calls this the fb modifier, which is defined in drm_mode\&.h of Linux UAPI\&. This is an opaque token\&. Drivers use this token to express tiling, compression, etc\&. driver-specific modifications to the base format defined by the DRM fourcc code\&. .PP Starting from version 4, the invalid_format protocol error is sent if the format + modifier pair was not advertised as supported\&. .PP This request raises the PLANE_IDX error if plane_idx is too large\&. The error PLANE_SET is raised if attempting to set a plane that was already set\&. .PP Definition at line \fB5011\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(int32_t, int32_t, uint32_t, zwp_linux_buffer_params_v1_flags)> & zwp_linux_buffer_params_v1_t::on_create ()" .PP create a wl_buffer from the given dmabufs .PP \fBParameters\fP .RS 4 \fIwidth\fP base plane width in pixels .br \fIheight\fP base plane height in pixels .br \fIformat\fP DRM_FORMAT code .br \fIflags\fP see enum flags .RE .PP This asks for creation of a wl_buffer from the added dmabuf buffers\&. The wl_buffer is not created immediately but returned via the 'created' event if the dmabuf sharing succeeds\&. The sharing may fail at runtime for reasons a client cannot predict, in which case the 'failed' event is triggered\&. .PP The 'format' argument is a DRM_FORMAT code, as defined by the libdrm's drm_fourcc\&.h\&. The Linux kernel's DRM sub-system is the authoritative source on how the format codes should work\&. .PP The 'flags' is a bitfield of the flags defined in enum 'flags'\&. 'y_invert' means the that the image needs to be y-flipped\&. .PP Flag 'interlaced' means that the frame in the buffer is not progressive as usual, but interlaced\&. An interlaced buffer as supported here must always contain both top and bottom fields\&. The top field always begins on the first pixel row\&. The temporal ordering between the two fields is top field first, unless 'bottom_first' is specified\&. It is undefined whether 'bottom_first' is ignored if 'interlaced' is not set\&. .PP This protocol does not convey any information about field rate, duration, or timing, other than the relative ordering between the two fields in one buffer\&. A compositor may have to estimate the intended field rate from the incoming buffer rate\&. It is undefined whether the time of receiving wl_surface\&.commit with a new buffer attached, applying the wl_surface state, wl_surface\&.frame callback trigger, presentation, or any other point in the compositor cycle is used to measure the frame or field times\&. There is no support for detecting missed or late frames/fields/buffers either, and there is no support whatsoever for cooperating with interlaced compositor output\&. .PP The composited image quality resulting from the use of interlaced buffers is explicitly undefined\&. A compositor may use elaborate hardware features or software to deinterlace and create progressive output frames from a sequence of interlaced input buffers, or it may produce substandard image quality\&. However, compositors that cannot guarantee reasonable image quality in all cases are recommended to just reject all interlaced buffers\&. .PP Any argument errors, including non-positive width or height, mismatch between the number of planes and the format, bad format, bad offset or stride, may be indicated by fatal protocol errors: INCOMPLETE, INVALID_FORMAT, INVALID_DIMENSIONS, OUT_OF_BOUNDS\&. .PP Dmabuf import errors in the server that are not obvious client bugs are returned via the 'failed' event as non-fatal\&. This allows attempting dmabuf sharing and falling back in the client if it fails\&. .PP This request can be sent only once in the object's lifetime, after which the only legal request is destroy\&. This object should be destroyed after issuing a 'create' request\&. Attempting to use this object after issuing 'create' raises ALREADY_USED protocol error\&. .PP It is not mandatory to issue 'create'\&. If a client wants to cancel the buffer creation, it can just destroy this object\&. .PP Definition at line \fB5017\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void(\fBbuffer_t\fP, int32_t, int32_t, uint32_t, zwp_linux_buffer_params_v1_flags)> & zwp_linux_buffer_params_v1_t::on_create_immed ()" .PP immediately create a wl_buffer from the given dmabufs .PP \fBParameters\fP .RS 4 \fIbuffer_id\fP id for the newly created wl_buffer .br \fIwidth\fP base plane width in pixels .br \fIheight\fP base plane height in pixels .br \fIformat\fP DRM_FORMAT code .br \fIflags\fP see enum flags .RE .PP This asks for immediate creation of a wl_buffer by importing the added dmabufs\&. .PP In case of import success, no event is sent from the server, and the wl_buffer is ready to be used by the client\&. .PP Upon import failure, either of the following may happen, as seen fit by the implementation: .IP "\(bu" 2 the client is terminated with one of the following fatal protocol errors: .IP " \(bu" 4 INCOMPLETE, INVALID_FORMAT, INVALID_DIMENSIONS, OUT_OF_BOUNDS, in case of argument errors such as mismatch between the number of planes and the format, bad format, non-positive width or height, or bad offset or stride\&. .IP " \(bu" 4 INVALID_WL_BUFFER, in case the cause for failure is unknown or plaform specific\&. .PP .IP "\(bu" 2 the server creates an invalid wl_buffer, marks it as failed and sends a 'failed' event to the client\&. The result of using this invalid wl_buffer as an argument in any request by the client is defined by the compositor implementation\&. .PP .PP This takes the same arguments as a 'create' request, and obeys the same restrictions\&. .PP Definition at line \fB5023\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "std::function< void()> & zwp_linux_buffer_params_v1_t::on_destroy ()" .PP delete this object, used or not Cleans up the temporary data sent to the server for dmabuf-based wl_buffer creation\&. .PP Definition at line \fB5005\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::post_already_used (std::string const & msg)" .PP Post error: the dmabuf_batch object has already been used to create a wl_buffer\&. .PP Definition at line \fB5039\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::post_incomplete (std::string const & msg)" .PP Post error: missing or too many planes to create a buffer\&. .PP Definition at line \fB5054\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::post_invalid_dimensions (std::string const & msg)" .PP Post error: invalid width or height\&. .PP Definition at line \fB5064\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::post_invalid_format (std::string const & msg)" .PP Post error: format not supported\&. .PP Definition at line \fB5059\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::post_invalid_wl_buffer (std::string const & msg)" .PP Post error: invalid wl_buffer resulted from importing dmabufs via the create_immed request on given buffer_params\&. .PP Definition at line \fB5074\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void wayland::server::resource_t::post_no_memory () const\fC [inherited]\fP" Post 'not enough memory' error to the client .PP If the compositor has not enough memory to fulfill a certail request of the client, this function can be called to notify the client of this circumstance\&. .SS "void zwp_linux_buffer_params_v1_t::post_out_of_bounds (std::string const & msg)" .PP Post error: offset + stride * height goes out of dmabuf bounds\&. .PP Definition at line \fB5069\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::post_plane_idx (std::string const & msg)" .PP Post error: plane index out of bounds\&. .PP Definition at line \fB5044\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "void zwp_linux_buffer_params_v1_t::post_plane_set (std::string const & msg)" .PP Post error: the plane index was already set\&. .PP Definition at line \fB5049\fP of file \fBwayland\-server\-protocol\-unstable\&.cpp\fP\&. .SS "bool wayland::server::resource_t::proxy_has_object () const\fC [inherited]\fP" .PP Check whether this wrapper actually wraps an object\&. .PP \fBReturns\fP .RS 4 true if there is an underlying object, false if this wrapper is empty .RE .PP .SH "Member Data Documentation" .PP .SS "constexpr std::uint32_t wayland::server::zwp_linux_buffer_params_v1_t::created_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBcreated\fP function\&. .PP Definition at line \fB1972\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SS "constexpr std::uint32_t wayland::server::zwp_linux_buffer_params_v1_t::failed_since_version = 1\fC [static]\fP, \fC [constexpr]\fP" .PP Minimum protocol version required for the \fBfailed\fP function\&. .PP Definition at line \fB1988\fP of file \fBwayland\-server\-protocol\-unstable\&.hpp\fP\&. .SH "Author" .PP Generated automatically by Doxygen for Wayland++ from the source code\&.