Class OffscreenPlaybackListener

Inheritance Relationships

Base Type

Class Documentation

class OffscreenPlaybackListener : public gpa::playback::IPlaybackListener

Public Functions

OffscreenPlaybackListener()
~OffscreenPlaybackListener()
virtual gpa::Surface *OnSurfaceRequest(uint64_t key, gpa::SurfaceCreateInfo const *createInfo) override

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) override

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() override

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

virtual void OnStreamEnd() override

Triggered when the stream is finished playing back.

virtual bool ShutdownRequested() override

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

virtual ShutdownRequestReason GetShutdownRequestReason() override

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