Wayland screencopy capture backend shared by RAM and VRAM paths. More...

Inheritance diagram for wl::wlr_t:

Collaboration diagram for wl::wlr_t:

Public Member Functions
int	dummy_img (platf::img_t *img) override
	Populate a fallback image when real capture data is unavailable.

int	init (platf::mem_type_e hwdevice_type, const std::string &display_name, const ::video::config_t &config)
	Initialize Wayland screencopy capture for the selected output.

platf::capture_e	snapshot (const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr< platf::img_t > &img_out, std::chrono::milliseconds timeout, bool cursor)
	Capture a display frame into the provided image object.

Public Member Functions inherited from platf::display_t
virtual std::shared_ptr< img_t >	alloc_img ()=0
	Allocate an image buffer compatible with this display backend.

virtual capture_e	capture (const push_captured_image_cb_t &push_captured_image_cb, const pull_free_image_cb_t &pull_free_image_cb, bool *cursor)=0
	Capture a frame.

virtual bool	get_hdr_metadata (SS_HDR_METADATA &metadata)
	Read HDR metadata for the active display mode.

virtual bool	is_codec_supported (std::string_view name, const ::video::config_t &config)
	Check that a given codec is supported by the display device.

virtual bool	is_hdr ()
	Report whether the active display mode is HDR.

virtual std::unique_ptr< avcodec_encode_device_t >	make_avcodec_encode_device (pix_fmt_e pix_fmt)
	Create AVCodec encode device.

virtual std::unique_ptr< nvenc_encode_device_t >	make_nvenc_encode_device (pix_fmt_e pix_fmt)
	Create NVENC encode device.

Public Attributes
std::chrono::nanoseconds	delay
	Delay before the timer task becomes eligible to run.

wl::display_t	display
	Wayland display connection used for capture.

dmabuf_t	dmabuf
	DMA-BUF feedback and format state advertised by the compositor.

interface_t	interface
	Wayland registry interfaces required by screencopy.

platf::mem_type_e	mem_type
	Mem type.

wl_output *	output
	Wayland output selected for capture.

Public Attributes inherited from platf::display_t
int	env_height {0}
	Height of the full capture environment in physical pixels.

int	env_logical_height {0}
	Height of the full capture environment after display scaling.

int	env_logical_width {0}
	Width of the full capture environment after display scaling.

int	env_width {0}
	Width of the full capture environment in physical pixels.

int	height {0}
	Height of the captured display in physical pixels.

int	logical_height {0}
	Height of the captured display after display scaling.

int	logical_width {0}
	Width of the captured display after display scaling.

int	offset_x {0}
	Horizontal capture offset in physical pixels.

int	offset_y {0}
	Vertical capture offset in physical pixels.

int	width {0}
	Width of the captured display in physical pixels.

Additional Inherited Members
Public Types inherited from platf::display_t
using	pull_free_image_cb_t = std::function<bool(std::shared_ptr<img_t> &img_out)>
	Get free image from pool. Calls must be synchronized. Blocks until there is free image in the pool or capture is interrupted.

using	push_captured_image_cb_t = std::function<bool(std::shared_ptr<img_t> &&img, bool frame_captured)>
	Callback for when a new image is ready. When display has a new image ready or a timeout occurs, this callback will be called with the image. If a frame was captured, frame_captured will be true. If a timeout occurred, it will be false.

Protected Attributes inherited from platf::display_t
logging::time_delta_periodic_logger	sleep_overshoot_logger = {debug, "Frame capture sleep overshoot"}
	Periodic logger for capture sleep overshoot measurements.

Detailed Description

Wayland screencopy capture backend shared by RAM and VRAM paths.

Member Function Documentation

int wl::wlr_t::dummy_img ( platf::img_t * img )

inlineoverridevirtual

Populate a fallback image when real capture data is unavailable.

Parameters

img	Image or frame object to read from or populate.

Reimplemented in wl::wlr_vram_t.

inline

Initialize Wayland screencopy capture for the selected output.

Parameters

hwdevice_type	Hardware device type requested for capture or encode.
display_name	Display name.
config	Configuration values to apply.

platf::capture_e wl::wlr_t::snapshot	(	const pull_free_image_cb_t &	pull_free_image_cb,
		std::shared_ptr< platf::img_t > &	img_out,
		std::chrono::milliseconds	timeout,
		bool	cursor )

inline

Capture a display frame into the provided image object.

Parameters

pull_free_image_cb	Callback that provides an available image buffer.
img_out	Captured wlroots image returned to the streaming pipeline.
timeout	Maximum time to wait for the operation.
cursor	Cursor image or visibility state to composite.

The documentation for this class was generated from the following file: