Sunshine latest
Self-hosted game stream host for Moonlight.
platf::kms::display_vram_t Class Reference
Inheritance diagram for platf::kms::display_vram_t:
[legend]
Collaboration diagram for platf::kms::display_vram_t:
[legend]

Public Member Functions

std::shared_ptr< img_talloc_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)
 Capture a frame.
 
 display_vram_t (mem_type_e mem_type)
 
int dummy_img (platf::img_t *img) override
 
int init (const std::string &display_name, const ::video::config_t &config)
 
std::unique_ptr< avcodec_encode_device_tmake_avcodec_encode_device (pix_fmt_e pix_fmt) override
 
capture_e snapshot (const pull_free_image_cb_t &pull_free_image_cb, std::shared_ptr< platf::img_t > &img_out, std::chrono::milliseconds, bool cursor)
 
- Public Member Functions inherited from platf::kms::display_t
 display_t (mem_type_e mem_type)
 
bool get_hdr_metadata (SS_HDR_METADATA &metadata)
 
int init (const std::string &display_name, const ::video::config_t &config)
 
bool is_hdr ()
 
capture_e refresh (file_t *file, egl::surface_descriptor_t *sd, std::optional< std::chrono::steady_clock::time_point > &frame_timestamp)
 
void update_cursor ()
 
- Public Member Functions inherited from platf::display_t
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 std::unique_ptr< nvenc_encode_device_tmake_nvenc_encode_device (pix_fmt_e pix_fmt)
 

Public Attributes

std::uint64_t sequence {}
 
- Public Attributes inherited from platf::kms::display_t
cursor_t captured_cursor {}
 
card_t card
 
std::optional< uint32_t > connector_id
 
int crtc_id
 
int crtc_index
 
int cursor_plane_id
 
std::chrono::nanoseconds delay
 
std::optional< uint64_t > hdr_metadata_blob_id
 
int img_height
 
int img_offset_x
 
int img_offset_y
 
int img_width
 
mem_type_e mem_type
 
int plane_id
 
- 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::kms::display_vram_t::alloc_img ( )
inlineoverridevirtual

Implements platf::display_t.

◆ capture()

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

Capture a frame.

Parameters
push_captured_image_cbThe callback that is called with captured image, must be called from the same thread as capture()
pull_free_image_cbCapture 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.
cursorA pointer to the flag that indicates whether the cursor should be captured as well.
Return values
capture_e::okWhen stopping
capture_e::errorOn error
capture_e::reinitWhen need of reinitialization

Implements platf::display_t.

◆ dummy_img()

int platf::kms::display_vram_t::dummy_img ( platf::img_t * img)
inlineoverridevirtual

Implements platf::display_t.

◆ make_avcodec_encode_device()

std::unique_ptr< avcodec_encode_device_t > platf::kms::display_vram_t::make_avcodec_encode_device ( pix_fmt_e pix_fmt)
inlineoverridevirtual

Reimplemented from platf::display_t.


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