Public Member Functions | Public Attributes | List of all members
iv::FrameUpdateClient Class Referenceabstract

#include <FrameUpdateClient.hpp>

Public Member Functions

 FrameUpdateClient (Instance *inst)
 
 ~FrameUpdateClient ()
 
Instance * instance ()
 
virtual void frame_update ()=0
 
void frame_update_pause ()
 sets update counter to 0 More...
 
void frame_update_resume ()
 sets update counter to 1 More...
 
void frame_update_inc ()
 increases update counter (we will be updating) More...
 
void frame_update_dec ()
 decreases update counter (vote against frame updates, only call this if frame_update_inc was called before) More...
 
bool frame_update_active ()
 

Public Attributes

ClientMarker cm
 

Detailed Description

Update counter: if > 0, then frame_update will be called once per frame. Update counter is set to 1 by default, so if you want to use frame_update_inc and frame_update_dec, you might want to call frame_update_pause after FrameUpdateClient construction.

Definition at line 15 of file FrameUpdateClient.hpp.

Constructor & Destructor Documentation

◆ FrameUpdateClient()

iv::FrameUpdateClient::FrameUpdateClient ( Instance *  inst)

Definition at line 8 of file FrameUpdateClient.cpp.

◆ ~FrameUpdateClient()

iv::FrameUpdateClient::~FrameUpdateClient ( )

Definition at line 21 of file FrameUpdateClient.cpp.

Member Function Documentation

◆ instance()

Instance * iv::FrameUpdateClient::instance ( )

Definition at line 30 of file FrameUpdateClient.cpp.

◆ frame_update()

virtual void iv::FrameUpdateClient::frame_update ( )
pure virtual

Implemented in iv::Scroller.

◆ frame_update_pause()

void iv::FrameUpdateClient::frame_update_pause ( )

sets update counter to 0

Definition at line 35 of file FrameUpdateClient.cpp.

◆ frame_update_resume()

void iv::FrameUpdateClient::frame_update_resume ( )

sets update counter to 1

Definition at line 49 of file FrameUpdateClient.cpp.

◆ frame_update_inc()

void iv::FrameUpdateClient::frame_update_inc ( )

increases update counter (we will be updating)

Definition at line 69 of file FrameUpdateClient.cpp.

◆ frame_update_dec()

void iv::FrameUpdateClient::frame_update_dec ( )

decreases update counter (vote against frame updates, only call this if frame_update_inc was called before)

Definition at line 83 of file FrameUpdateClient.cpp.

◆ frame_update_active()

bool iv::FrameUpdateClient::frame_update_active ( )

Definition at line 63 of file FrameUpdateClient.cpp.

Member Data Documentation

◆ cm

ClientMarker iv::FrameUpdateClient::cm

Definition at line 18 of file FrameUpdateClient.hpp.

The documentation for this class was generated from the following files: