Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
CScreenShot Class Reference

#include <Screenshot.h>

Static Public Member Functions

static void Register (const std::function< std::unique_ptr< IScreenshotSurface >()> &createFunc)
 
static std::unique_ptr< IScreenshotSurfaceCreateSurface ()
 Create the platform's capture readback surface, null when none registered.
 
static void TakeScreenshot ()
 
static void TakeScreenshot (KODI::RENDERING::CAPTURE::CaptureContent content)
 Screenshot of the given content into the configured folder.
 
static void TakeScreenshot (const std::string &filename, KODI::RENDERING::CAPTURE::CaptureContent content=KODI::RENDERING::CAPTURE::CaptureContent::COMPOSITE)
 
static void TakeScreenshotBoth ()
 Capture the video-only image and the full composite from the same rendered frame into two files in the configured folder (screenshotNNNNN.png and screenshotNNNNN-video.png).
 

Member Function Documentation

◆ CreateSurface()

std::unique_ptr< IScreenshotSurface > CScreenShot::CreateSurface ( )
static

Create the platform's capture readback surface, null when none registered.

◆ Register()

void CScreenShot::Register ( const std::function< std::unique_ptr< IScreenshotSurface >()> & createFunc)
static

◆ TakeScreenshot() [1/3]

void CScreenShot::TakeScreenshot ( )
static

◆ TakeScreenshot() [2/3]

void CScreenShot::TakeScreenshot ( const std::string & filename,
KODI::RENDERING::CAPTURE::CaptureContent content = KODI::RENDERING::CAPTURE::CaptureContent::COMPOSITE )
static

◆ TakeScreenshot() [3/3]

void CScreenShot::TakeScreenshot ( KODI::RENDERING::CAPTURE::CaptureContent content)
static

Screenshot of the given content into the configured folder.

◆ TakeScreenshotBoth()

void CScreenShot::TakeScreenshotBoth ( )
static

Capture the video-only image and the full composite from the same rendered frame into two files in the configured folder (screenshotNNNNN.png and screenshotNNNNN-video.png).


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