APEX Framework: nvidia::apex::ReadLock Class Reference

NVIDIA APEX

nvidia::apex::ReadLock Class Reference

RAII wrapper for the Scene read lock. More...

#include <Lock.h>

List of all members.

Public Member Functions

 ReadLock (const ApexInterface &lockable, const char *file=NULL, uint32_t line=0)
 Constructor.

Detailed Description

RAII wrapper for the Scene read lock.

Use this class as follows to lock the scene for reading by the current thread for the duration of the enclosing scope:

ReadLock lock(sceneRef);

See also:
Scene::apexacquireReadLock(), Scene::apexUnacquireReadLock(), SceneDesc::useRWLock

Constructor & Destructor Documentation

nvidia::apex::ReadLock::ReadLock ( const ApexInterface lockable,
const char *  file = NULL,
uint32_t  line = 0 
) [inline]

Constructor.

Parameters:
lockableThe object to lock for reading
fileOptional string for debugging purposes
lineOptional line number for debugging purposes

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

Generated on Fri Dec 15 2017 13:58:39

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.