Inheritance diagram for platf::av_display_t:

Collaboration diagram for platf::av_display_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.

int	dummy_img (img_t *img) override

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

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)

Static Public Member Functions
static void	setPixelFormat (void *display, OSType pixelFormat)

static void	setResolution (void *display, int width, int height)

Public Attributes
AVVideo *	av_capture {}

CGDirectDisplayID	display_id {}

Public Attributes inherited from platf::display_t
int	env_height {0}

int	env_logical_height {0}

int	env_logical_width {0}

int	env_width {0}

int	height {0}

int	logical_height {0}

int	logical_width {0}

int	offset_x {0}

int	offset_y {0}

int	width {0}

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::av_display_t::alloc_img ( )

inlineoverridevirtual

capture_e platf::av_display_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

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

inlineoverridevirtual

std::unique_ptr< avcodec_encode_device_t > platf::av_display_t::make_avcodec_encode_device ( pix_fmt_e pix_fmt )

inlineoverridevirtual

Reimplemented from platf::display_t.

static void platf::av_display_t::setResolution	(	void *	display,
		int	width,
		int	height )

inlinestatic

A bridge from the pure C++ code of the hwdevice_t class to the pure Objective C code.

display --> an opaque pointer to an object of this class width --> the intended capture width height --> the intended capture height

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