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::IImage * | GetScreenshotImage () const =0 |
| Get the current screen shot image. More... | |
 Public Member Functions inherited from Murl::IControlable | |
| virtual const String & | GetName () 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()
|
pure virtual |
Create a screen shot of the next frame tick.
- Returns
- true if successful.
◆ DestroyScreenshot()
|
pure virtual |
Destroy the current screen shot.
- Returns
- true if successful.
◆ IsBusy()
|
pure virtual |
Check if the current screen shot is in progress.
- Returns
- true if the current screen shot is in progress.
◆ IsReady()
|
pure virtual |
Check if the current screen shot is ready to use.
- Returns
- true if the current screen shot is ready to use.
◆ GetScreenshotImage()
|
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