dmabuf

Documentation

Overview

Package dmabuf .

Index

• Constants
• type ZwpLinuxBufferParams
  • func NewZwpLinuxBufferParams(ctx *wl.Context) *ZwpLinuxBufferParams
  • func (p *ZwpLinuxBufferParams) Add(fd uintptr, plane_idx, offset, stride, modifier_hi, modifier_lo uint32) error
  • func (p *ZwpLinuxBufferParams) AddCreatedHandler(h ZwpLinuxBufferParamsCreatedHandler)
  • func (p *ZwpLinuxBufferParams) AddFailedHandler(h ZwpLinuxBufferParamsFailedHandler)
  • func (p *ZwpLinuxBufferParams) Create(width, height int32, format, flags uint32) error
  • func (p *ZwpLinuxBufferParams) CreateImmed(width, height int32, format, flags uint32) (*wl.Buffer, error)
  • func (p *ZwpLinuxBufferParams) Destroy() error
  • func (p *ZwpLinuxBufferParams) Dispatch(event *wl.Event)
  • func (p *ZwpLinuxBufferParams) RemoveCreatedHandler(h ZwpLinuxBufferParamsCreatedHandler)
  • func (p *ZwpLinuxBufferParams) RemoveFailedHandler(h ZwpLinuxBufferParamsFailedHandler)
• type ZwpLinuxBufferParamsCreatedEvent
• type ZwpLinuxBufferParamsCreatedHandler
• type ZwpLinuxBufferParamsFailedEvent
• type ZwpLinuxBufferParamsFailedHandler
• type ZwpLinuxDmabuf
  • func NewZwpLinuxDmabuf(ctx *wl.Context) *ZwpLinuxDmabuf
  • func (p *ZwpLinuxDmabuf) AddFormatHandler(h ZwpLinuxDmabufFormatHandler)
  • func (p *ZwpLinuxDmabuf) AddModifierHandler(h ZwpLinuxDmabufModifierHandler)
  • func (p *ZwpLinuxDmabuf) CreateParams() (*ZwpLinuxBufferParams, error)
  • func (p *ZwpLinuxDmabuf) Destroy() error
  • func (p *ZwpLinuxDmabuf) Dispatch(event *wl.Event)
  • func (p *ZwpLinuxDmabuf) RemoveFormatHandler(h ZwpLinuxDmabufFormatHandler)
  • func (p *ZwpLinuxDmabuf) RemoveModifierHandler(h ZwpLinuxDmabufModifierHandler)
• type ZwpLinuxDmabufFormatEvent
• type ZwpLinuxDmabufFormatHandler
• type ZwpLinuxDmabufModifierEvent
• type ZwpLinuxDmabufModifierHandler

Constants

const (
	ZwpLinuxBufferParamsErrorAlreadyUsed       = 0
	ZwpLinuxBufferParamsErrorPlaneIDx          = 1
	ZwpLinuxBufferParamsErrorPlaneSet          = 2
	ZwpLinuxBufferParamsErrorIncomplete        = 3
	ZwpLinuxBufferParamsErrorInvalidFormat     = 4
	ZwpLinuxBufferParamsErrorInvalidDimensions = 5
	ZwpLinuxBufferParamsErrorOutOfBounds       = 6
	ZwpLinuxBufferParamsErrorInvalidWlBuffer   = 7
)

const (
	ZwpLinuxBufferParamsFlagsYInvert     = 1
	ZwpLinuxBufferParamsFlagsInterlaced  = 2
	ZwpLinuxBufferParamsFlagsBottomFirst = 4
)

Types

type ZwpLinuxBufferParams

type ZwpLinuxBufferParams struct {
	wl.BaseProxy
	// contains filtered or unexported fields
}

func NewZwpLinuxBufferParams

func NewZwpLinuxBufferParams(ctx *wl.Context) *ZwpLinuxBufferParams

func (*ZwpLinuxBufferParams) Add

func (p *ZwpLinuxBufferParams) Add(fd uintptr, plane_idx, offset, stride, modifier_hi, modifier_lo uint32) error

Add will add a dmabuf to the temporary set.

This request adds one dmabuf to the set in this zwp_linux_buffer_params_v1.

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.

Warning: It should be an error if the format/modifier pair was not advertised with the modifier event. This is not enforced yet because some implementations always accept DRM_FORMAT_MOD_INVALID. Also version 2 of this protocol does not have the modifier event.

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.

func (*ZwpLinuxBufferParams) AddCreatedHandler

func (p *ZwpLinuxBufferParams) AddCreatedHandler(h ZwpLinuxBufferParamsCreatedHandler)

func (*ZwpLinuxBufferParams) AddFailedHandler

func (p *ZwpLinuxBufferParams) AddFailedHandler(h ZwpLinuxBufferParamsFailedHandler)

func (*ZwpLinuxBufferParams) Create

func (p *ZwpLinuxBufferParams) Create(width, height int32, format, flags uint32) error

Create will create a wl_buffer from the given dmabufs.

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.

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.

The 'flags' is a bitfield of the flags defined in enum "flags". 'y_invert' means the that the image needs to be y-flipped.

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.

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.

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.

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.

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.

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.

It is not mandatory to issue 'create'. If a client wants to cancel the buffer creation, it can just destroy this object.

func (*ZwpLinuxBufferParams) CreateImmed

func (p *ZwpLinuxBufferParams) CreateImmed(width, height int32, format, flags uint32) (*wl.Buffer, error)

CreateImmed will immediately create a wl_buffer from the given dmabufs.

This asks for immediate creation of a wl_buffer by importing the added dmabufs.

In case of import success, no event is sent from the server, and the wl_buffer is ready to be used by the client.

Upon import failure, either of the following may happen, as seen fit by the implementation: - the client is terminated with one of the following fatal protocol errors: - 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. - INVALID_WL_BUFFER, in case the cause for failure is unknown or plaform specific. - 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.

This takes the same arguments as a 'create' request, and obeys the same restrictions.

func (*ZwpLinuxBufferParams) Destroy

func (p *ZwpLinuxBufferParams) Destroy() error

Destroy will delete this object, used or not.

Cleans up the temporary data sent to the server for dmabuf-based wl_buffer creation.

func (*ZwpLinuxBufferParams) Dispatch

func (p *ZwpLinuxBufferParams) Dispatch(event *wl.Event)

func (*ZwpLinuxBufferParams) RemoveCreatedHandler

func (p *ZwpLinuxBufferParams) RemoveCreatedHandler(h ZwpLinuxBufferParamsCreatedHandler)

func (*ZwpLinuxBufferParams) RemoveFailedHandler

func (p *ZwpLinuxBufferParams) RemoveFailedHandler(h ZwpLinuxBufferParamsFailedHandler)

type ZwpLinuxBufferParamsCreatedEvent

type ZwpLinuxBufferParamsCreatedEvent struct {
	Buffer *wl.Buffer
}

type ZwpLinuxBufferParamsCreatedHandler

type ZwpLinuxBufferParamsCreatedHandler interface {
	HandleZwpLinuxBufferParamsCreated(ZwpLinuxBufferParamsCreatedEvent)
}

type ZwpLinuxBufferParamsFailedEvent

type ZwpLinuxBufferParamsFailedEvent struct{}

type ZwpLinuxBufferParamsFailedHandler

type ZwpLinuxBufferParamsFailedHandler interface {
	HandleZwpLinuxBufferParamsFailed(ZwpLinuxBufferParamsFailedEvent)
}

type ZwpLinuxDmabuf

type ZwpLinuxDmabuf struct {
	wl.BaseProxy
	// contains filtered or unexported fields
}

func NewZwpLinuxDmabuf

func NewZwpLinuxDmabuf(ctx *wl.Context) *ZwpLinuxDmabuf

func (*ZwpLinuxDmabuf) AddFormatHandler

func (p *ZwpLinuxDmabuf) AddFormatHandler(h ZwpLinuxDmabufFormatHandler)

func (*ZwpLinuxDmabuf) AddModifierHandler

func (p *ZwpLinuxDmabuf) AddModifierHandler(h ZwpLinuxDmabufModifierHandler)

func (*ZwpLinuxDmabuf) CreateParams

func (p *ZwpLinuxDmabuf) CreateParams() (*ZwpLinuxBufferParams, error)

CreateParams will create a temporary object for buffer parameters.

This temporary object is used to collect multiple dmabuf handles into a single batch to create a wl_buffer. It can only be used once and should be destroyed after a 'created' or 'failed' event has been received.

func (*ZwpLinuxDmabuf) Destroy

func (p *ZwpLinuxDmabuf) Destroy() error

Destroy will unbind the factory.

Objects created through this interface, especially wl_buffers, will remain valid.

func (*ZwpLinuxDmabuf) Dispatch

func (p *ZwpLinuxDmabuf) Dispatch(event *wl.Event)

func (*ZwpLinuxDmabuf) RemoveFormatHandler

func (p *ZwpLinuxDmabuf) RemoveFormatHandler(h ZwpLinuxDmabufFormatHandler)

func (*ZwpLinuxDmabuf) RemoveModifierHandler

func (p *ZwpLinuxDmabuf) RemoveModifierHandler(h ZwpLinuxDmabufModifierHandler)

type ZwpLinuxDmabufFormatEvent

type ZwpLinuxDmabufFormatEvent struct {
	Format uint32
}

type ZwpLinuxDmabufFormatHandler

type ZwpLinuxDmabufFormatHandler interface {
	HandleZwpLinuxDmabufFormat(ZwpLinuxDmabufFormatEvent)
}

type ZwpLinuxDmabufModifierEvent

type ZwpLinuxDmabufModifierEvent struct {
	Format     uint32
	ModifierHi uint32
	ModifierLo uint32
}

type ZwpLinuxDmabufModifierHandler

type ZwpLinuxDmabufModifierHandler interface {
	HandleZwpLinuxDmabufModifier(ZwpLinuxDmabufModifierEvent)
}