Class RangePlayer

Inheritance Relationships

Base Type

Class Documentation

class RangePlayer : public gpa::playback::CallableBroadcaster

Helper class for performing playback on a range.

This class acts as a layer on top of a simple player and encapsulates a lot of the range playback logic. It handles the snapshot, state restoration on each run, and other details that are required for range playback to function.

Public Functions

RangePlayer(Player *player, PlaybackPreprocessor *playbackPreprocessor, bool flattenSecondaryCommandBuffers)
Parameters

  • player -- The player that will be used to play back the range calls.

  • playbackPreprocessor -- The object that will perform stream analysis required for range repeat

  • flattenSecondaryCommandBuffers -- Whether or not to flatten secondary command buffers.

~RangePlayer()
virtual void ConnectExecutionCallbacks(ExecutionCallbacks const &callbacks) override
virtual void DisconnectExecutionCallbacks() override
void Execute()
void InitializeRangePlayback()

Method that should be called before the first PlayRange.

bool PlayRange(ExecutionCallbacks const *callbacks)

Plays through one iteration of the range.

Parameters

callbacks -- User-callbacks that will be called before and after each call within the range.

void FinalizeRangePlayback()

Method that should be called after the last PlayRange.

CallableCache *GetRangeCache()

Returns processed callable cache.