Visualization Library 2.0.0-b3

A lightweight C++ OpenGL middleware for 2D/3D graphics

VL     Star     Watch     Fork     Issue

[Download] [Tutorials] [All Classes] [Grouped Classes]
Public Member Functions | Protected Attributes | List of all members
vl::CopyTexSubImage Class Referenceabstract

Wrapper class of the OpenGL function glCopyTexSubImage. More...

#include <CopyTexSubImage.hpp>

+ Inheritance diagram for vl::CopyTexSubImage:

Public Member Functions

 CopyTexSubImage ()
 
EReadDrawBuffer readBuffer () const
 The source buffer used when copying color buffers, ignored when using depth textures. More...
 
void setReadBuffer (EReadDrawBuffer render_buffer)
 The source buffer used when copying color buffers, ignored when using depth textures. More...
 
virtual bool onRenderingStarted (const RenderingAbstract *)
 Reimplement to react to this event. More...
 
virtual bool onRenderingFinished (const RenderingAbstract *)
 Reimplement to react to this event. More...
 
virtual bool onRendererStarted (const RendererAbstract *)
 Reimplement to react to this event. More...
 
virtual bool onRendererFinished (const RendererAbstract *)
 Reimplement to react to this event. More...
 
virtual void copyPixels ()=0
 Copies the pixels from the specified read buffer to the specified texture. More...
 
- Public Member Functions inherited from vl::RenderEventCallback
 RenderEventCallback ()
 
void setRemoveAfterCall (bool remove)
 Defines if the callback shall be removed after being executed. More...
 
bool removeAfterCall () const
 Defines if the callback shall be removed after being executed. More...
 
void setEnabled (bool enabled)
 Enabled/disabled callback. More...
 
bool isEnabled () const
 Whether the callback is enabled or not. More...
 
- Public Member Functions inherited from vl::Object
 Object ()
 Constructor. More...
 
 Object (const Object &other)
 Copy constructor: copies the name, ref count mutex and user data. More...
 
Objectoperator= (const Object &other)
 Copy operator: copies the object's name, ref count mutex and user data. More...
 
const std::string & objectName () const
 The name of the object, by default set to the object's class name. More...
 
void setObjectName (const char *name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setObjectName (const std::string &name)
 The name of the object, by default set to the object's class name in debug builds. More...
 
void setRefCountMutex (IMutex *mutex)
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
IMutexrefCountMutex ()
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
const IMutexrefCountMutex () const
 The mutex used to protect the reference counting of an Object across multiple threads. More...
 
int referenceCount () const
 Returns the number of references of an object. More...
 
void incReference () const
 Increments the reference count of an object. More...
 
void decReference ()
 Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
 
void setAutomaticDelete (bool autodel_on)
 If set to true the Object is deleted when its reference count reaches 0. More...
 
bool automaticDelete () const
 If set to true the Object is deleted when its reference count reaches 0. More...
 
template<class T >
T * as ()
 Casts an Object to the specified class. More...
 
template<class T >
const T * as () const
 Casts an Object to the specified class. More...
 

Protected Attributes

EReadDrawBuffer mReadBuffer
 
- Protected Attributes inherited from vl::RenderEventCallback
bool mRemoveAfterCall
 
bool mEnabled
 
- Protected Attributes inherited from vl::Object
std::string mObjectName
 
IMutexmRefCountMutex
 
int mReferenceCount
 
bool mAutomaticDelete
 

Additional Inherited Members

- Protected Member Functions inherited from vl::Object
virtual ~Object ()
 

Detailed Description

Wrapper class of the OpenGL function glCopyTexSubImage.

Is the base class of CopyTexSubImage1D, CopyTexSubImage2D, CopyTexSubImage3D. Copies a rectangular pixels area from the specified read buffer to the specified portion of the texture. Can be bound to a Rendering as a RenderEventCallback in order to automatically copy the result of a rendering into a texture, see Rendering.

Note
This class supports Frame-Buffer-Objects, 3D textures, cubemaps.
See also
FramebufferObject, FBOAbstractAttachment, Rendering, RenderEventCallback, CopyTexSubImage1D, CopyTexSubImage2D, CopyTexSubImage3D

Definition at line 56 of file CopyTexSubImage.hpp.

Constructor & Destructor Documentation

◆ CopyTexSubImage()

vl::CopyTexSubImage::CopyTexSubImage ( )
inline

Definition at line 61 of file CopyTexSubImage.hpp.

Member Function Documentation

◆ copyPixels()

virtual void vl::CopyTexSubImage::copyPixels ( )
pure virtual

Copies the pixels from the specified read buffer to the specified texture.

Implemented in vl::CopyTexSubImage3D, vl::CopyTexSubImage2D, and vl::CopyTexSubImage1D.

Referenced by onRendererFinished(), onRendererStarted(), onRenderingFinished(), and onRenderingStarted().

◆ onRendererFinished()

virtual bool vl::CopyTexSubImage::onRendererFinished ( const RendererAbstract )
inlinevirtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implements vl::RenderEventCallback.

Definition at line 90 of file CopyTexSubImage.hpp.

References copyPixels().

◆ onRendererStarted()

virtual bool vl::CopyTexSubImage::onRendererStarted ( const RendererAbstract )
inlinevirtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implements vl::RenderEventCallback.

Definition at line 84 of file CopyTexSubImage.hpp.

References copyPixels().

◆ onRenderingFinished()

virtual bool vl::CopyTexSubImage::onRenderingFinished ( const RenderingAbstract )
inlinevirtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implements vl::RenderEventCallback.

Definition at line 78 of file CopyTexSubImage.hpp.

References copyPixels().

◆ onRenderingStarted()

virtual bool vl::CopyTexSubImage::onRenderingStarted ( const RenderingAbstract )
inlinevirtual

Reimplement to react to this event.

Returns
true if the callback reacted to the given event.

Implements vl::RenderEventCallback.

Definition at line 72 of file CopyTexSubImage.hpp.

References copyPixels().

◆ readBuffer()

EReadDrawBuffer vl::CopyTexSubImage::readBuffer ( ) const
inline

The source buffer used when copying color buffers, ignored when using depth textures.

Definition at line 67 of file CopyTexSubImage.hpp.

References mReadBuffer.

Referenced by vl::CopyTexSubImage1D::copyPixels(), vl::CopyTexSubImage2D::copyPixels(), and vl::CopyTexSubImage3D::copyPixels().

◆ setReadBuffer()

void vl::CopyTexSubImage::setReadBuffer ( EReadDrawBuffer  render_buffer)
inline

The source buffer used when copying color buffers, ignored when using depth textures.

Definition at line 70 of file CopyTexSubImage.hpp.

References mReadBuffer.

Referenced by vl::CopyTexSubImage1D::CopyTexSubImage1D(), vl::CopyTexSubImage2D::CopyTexSubImage2D(), and vl::CopyTexSubImage3D::CopyTexSubImage3D().

Member Data Documentation

◆ mReadBuffer

EReadDrawBuffer vl::CopyTexSubImage::mReadBuffer
protected

Definition at line 102 of file CopyTexSubImage.hpp.

Referenced by readBuffer(), and setReadBuffer().


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