clan::PixelBufferLock< Type > Class Template Reference

PixelBuffer locking helper. More...

#include <pixel_buffer_lock.h>

Public Member Functions

 PixelBufferLock (GraphicContext &gc, PixelBuffer &pixel_buffer, BufferAccess access, bool lock_pixelbuffer=true)
 Constructs a gpu pixel buffer lock. More...
 
 PixelBufferLock (PixelBuffer &pixel_buffer, bool lock_pixelbuffer=true)
 Constructs a system pixel buffer lock. More...
 
 ~PixelBufferLock ()
 
Type * get_data ()
 
int get_height () const
 
int get_lock_count () const
 Returns the amounts of recursive pixel_buffer locks performed by this section. More...
 
int get_pitch () const
 
Type & get_pixel (int x, int y)
 
Type * get_row (int y)
 
int get_width () const
 
void lock (GraphicContext &gc, BufferAccess access)
 Lock the gpu pixel_buffer. More...
 
void lock ()
 Lock the system pixel_buffer. More...
 
void unlock ()
 Unlock pixel_buffer. More...
 

Detailed Description

template<typename Type>
class clan::PixelBufferLock< Type >

PixelBuffer locking helper.

Constructor & Destructor Documentation

template<typename Type >
clan::PixelBufferLock< Type >::PixelBufferLock ( GraphicContext gc,
PixelBuffer pixel_buffer,
BufferAccess  access,
bool  lock_pixelbuffer = true 
)
inline
template<typename Type >
clan::PixelBufferLock< Type >::PixelBufferLock ( PixelBuffer pixel_buffer,
bool  lock_pixelbuffer = true 
)
inline
template<typename Type >
clan::PixelBufferLock< Type >::~PixelBufferLock ( )
inline

Member Function Documentation

template<typename Type >
Type* clan::PixelBufferLock< Type >::get_data ( )
inline
template<typename Type >
int clan::PixelBufferLock< Type >::get_height ( ) const
inline
template<typename Type >
int clan::PixelBufferLock< Type >::get_lock_count ( ) const
inline

Returns the amounts of recursive pixel_buffer locks performed by this section.

template<typename Type >
int clan::PixelBufferLock< Type >::get_pitch ( ) const
inline
template<typename Type >
Type& clan::PixelBufferLock< Type >::get_pixel ( int  x,
int  y 
)
inline

References clan::y.

template<typename Type >
Type* clan::PixelBufferLock< Type >::get_row ( int  y)
inline

References clan::y.

template<typename Type >
int clan::PixelBufferLock< Type >::get_width ( ) const
inline
template<typename Type >
void clan::PixelBufferLock< Type >::lock ( GraphicContext gc,
BufferAccess  access 
)
inline
template<typename Type >
void clan::PixelBufferLock< Type >::lock ( )
inline
template<typename Type >
void clan::PixelBufferLock< Type >::unlock ( )
inline

Unlock pixel_buffer.

References clan::PixelBuffer::is_null(), and clan::PixelBuffer::unlock().


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