StateBag::GetStateAddRef

StateBag::GetStateAddRef
virtual State* GetStateAddRef(State::StateType state) const;
Description

GetStateAddRef obtains one or more State pointers based on the specified state type. States are maintained in a thread-safe container in GFx. GetStateAddRef increments state reference count to eliminate possibility of another thread releasing the state object while its pointer is being returned to the user. Users should release the state after they are done accessing its values.

Parameters
Parameters 
Description 
State::StateType state 
State type being requested such as State_Log, State_FileOpener, State_FSCommandHandler, etc.