Class IPlaybackListener

Inheritance Relationships

Derived Types

Class Documentation

class IPlaybackListener

Users who wish to listen into events triggered during the playback stream should implement this interface and register it with the playback interface.

Subclassed by gpa::playback::DefaultPlaybackListener, gpa::playback::OffscreenPlaybackListener

Public Functions

IPlaybackListener()
virtual ~IPlaybackListener()
virtual Surface *OnSurfaceRequest(uint64_t key, SurfaceCreateInfo const *createInfo) = 0

Triggered when the playback stream attempts to use a surface, such as during vkCreateXcbSurfaceKHR.

Note

If createInfo is NULL, and the surface referenced by key does not exist, this method will return NULL.

Parameters

  • key -- Surface key from capture time

  • createInfo -- Struct containing parameters for surface creation, or NULL if surface expected to exist

Returns

Surface* describing the surface, if it exists; NULL otherwise.

virtual void OnSurfaceResize(uint64_t key, int width, int height) = 0

Triggered when the playback stream attempts to resize the window.

Parameters

  • key -- The surface key, used to identify which surface to resize if there are multiple.

  • width -- The new width of the surface

  • height -- The new height of the surface

virtual void OnYield() = 0

Triggered periodically when playback yields to the system (for instance, to run a message pump)

virtual void OnStreamEnd() = 0

Triggered when the stream is finished playing back.

virtual bool ShutdownRequested() = 0

Returns true if user requested shutdown (i.e. closed a playback window)

virtual ShutdownRequestReason GetShutdownRequestReason()

Returns enum value representing the reason why the listener requested the shutdown.

inline virtual void SetAppName(const char*)

Sets windows title.