Inheritance diagram for platf::shm_attr_t:

Collaboration diagram for platf::shm_attr_t:

Public Member Functions
std::shared_ptr< img_t >	alloc_img () override

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) override
	Capture a frame.

void	delayed_refresh ()

int	dummy_img (platf::img_t *img) override

std::uint32_t	frame_size ()

int	init (const std::string &display_name, const ::video::config_t &config)

	shm_attr_t (mem_type_e mem_type)

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)

Public Member Functions inherited from platf::x11_attr_t
std::shared_ptr< img_t >	alloc_img () override

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) override
	Capture a frame.

int	dummy_img (img_t *img) override

int	init (const std::string &display_name, const ::video::config_t &config)

std::unique_ptr< avcodec_encode_device_t >	make_avcodec_encode_device (pix_fmt_e pix_fmt) override

void	refresh ()

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)

	x11_attr_t (mem_type_e mem_type)

Public Member Functions inherited from platf::display_t
virtual bool	get_hdr_metadata (SS_HDR_METADATA &metadata)

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 ()

virtual std::unique_ptr< nvenc_encode_device_t >	make_nvenc_encode_device (pix_fmt_e pix_fmt)

Public Attributes
shm_data_t	data

xcb_screen_t *	display

task_pool_util::TaskPool::task_id_t	refresh_task_id

std::uint32_t	seg

shm_id_t	shm_id

x11::xdisplay_t	shm_xdisplay

xcb_connect_t	xcb

Public Attributes inherited from platf::x11_attr_t
std::chrono::nanoseconds	delay

mem_type_e	mem_type

XWindowAttributes	xattr

x11::xdisplay_t	xdisplay

Window	xwindow

Public Attributes inherited from platf::display_t
int	env_height

int	env_width

int	height

int	offset_x

int	offset_y

int	width

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"}

Member Function Documentation

◆ alloc_img()

std::shared_ptr< img_t > platf::shm_attr_t::alloc_img ( )

inlineoverridevirtual

Implements platf::display_t.

◆ capture()

capture_e platf::shm_attr_t::capture	(	const push_captured_image_cb_t &	push_captured_image_cb,
		const pull_free_image_cb_t &	pull_free_image_cb,
		bool *	cursor )

inlineoverridevirtual

Capture a frame.

Parameters

push_captured_image_cb	The callback that is called with captured image, must be called from the same thread as capture()
pull_free_image_cb	Capture backends call this callback to get empty image from the pool. If backend uses multiple threads, calls to this callback must be synchronized. Calls to this callback and push_captured_image_cb must be synchronized as well.
cursor	A pointer to the flag that indicates whether the cursor should be captured as well.

Return values

capture_e::ok	When stopping
capture_e::error	On error
capture_e::reinit	When need of reinitialization

Implements platf::display_t.

◆ dummy_img()

int platf::shm_attr_t::dummy_img ( platf::img_t * img )

inlineoverridevirtual

Implements platf::display_t.

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

src/platform/linux/x11grab.cpp

Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

◆ alloc_img()

◆ capture()

◆ dummy_img()