Murl::IScreenshotControl Interface Referenceabstract

The IScreenshotControl interface. More...

#include "murl_i_screenshot_control.h"

Inheritance diagram for Murl::IScreenshotControl:

Public Member Functions

virtual Bool CreateScreenshot ()=0
 Create a screen shot of the next frame tick. More...
 
virtual Bool DestroyScreenshot ()=0
 Destroy the current screen shot. More...
 
virtual Bool IsBusy () const =0
 Check if the current screen shot is in progress. More...
 
virtual Bool IsReady () const =0
 Check if the current screen shot is ready to use. More...
 
virtual const Resource::IImageGetScreenshotImage () const =0
 Get the current screen shot image. More...
 
- Public Member Functions inherited from Murl::IControlable
virtual const StringGetName () const =0
 Get the controlable's name. More...
 
virtual void FrameUpdate ()=0
 Is executed in the platform thread context each frame tick.
 
virtual void LogicUpdate ()=0
 Is executed in the logic thread context each logic tick.
 
virtual void ConfigChanged (const IAppConfiguration *appConfig)=0
 Notification of changed configuration. More...
 

Detailed Description

The IScreenshotControl interface.

Member Function Documentation

◆ CreateScreenshot()

virtual Bool Murl::IScreenshotControl::CreateScreenshot ( )
pure virtual

Create a screen shot of the next frame tick.

Returns
true if successful.

◆ DestroyScreenshot()

virtual Bool Murl::IScreenshotControl::DestroyScreenshot ( )
pure virtual

Destroy the current screen shot.

Returns
true if successful.

◆ IsBusy()

virtual Bool Murl::IScreenshotControl::IsBusy ( ) const
pure virtual

Check if the current screen shot is in progress.

Returns
true if the current screen shot is in progress.

◆ IsReady()

virtual Bool Murl::IScreenshotControl::IsReady ( ) const
pure virtual

Check if the current screen shot is ready to use.

Returns
true if the current screen shot is ready to use.

◆ GetScreenshotImage()

virtual const Resource::IImage* Murl::IScreenshotControl::GetScreenshotImage ( ) const
pure virtual

Get the current screen shot image.

Returns
The current screen shot image or null if no image is available.

The documentation for this interface was generated from the following file:
  • murl_i_screenshot_control.h


Copyright © 2011-2018 Spraylight GmbH.