Crazy Eddies GUI System  0.7.0
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
CEGUI::OpenGLWGLPBTextureTarget Class Reference

OpenGLWGLPBTextureTarget - allows rendering to an OpenGL texture via the pbuffer WGL extension. More...

+ Inheritance diagram for CEGUI::OpenGLWGLPBTextureTarget:
+ Collaboration diagram for CEGUI::OpenGLWGLPBTextureTarget:

Public Member Functions

 OpenGLWGLPBTextureTarget (OpenGLRenderer &owner)
 
void activate ()
 Activate the render target and put it in a state ready to be drawn to. More...
 
void deactivate ()
 Deactivate the render target after having completed rendering. More...
 
bool isImageryCache () const
 Return whether the RenderTarget is an implementation that caches actual rendered imagery. More...
 
void clear ()
 Clear the surface of the underlying texture.
 
TexturegetTexture () const
 Return a pointer to the CEGUI::Texture that the TextureTarget is using. More...
 
void declareRenderSize (const Size &sz)
 Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations. More...
 
bool isRenderingInverted () const
 Return whether rendering done on the target texture is inverted in relation to regular textures. More...
 
- Public Member Functions inherited from CEGUI::OpenGLRenderTarget
 OpenGLRenderTarget (OpenGLRenderer &owner)
 Constructor.
 
void draw (const GeometryBuffer &buffer)
 Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents. More...
 
void draw (const RenderQueue &queue)
 Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents. More...
 
void setArea (const Rect &area)
 Set the area for this RenderTarget. The exact action this function will take depends upon what the concrete class is representing. For example, with a 'view port' style RenderTarget, this should set the area that the view port occupies on the display (or rendering window). More...
 
const RectgetArea () const
 Return the area defined for this RenderTarget. More...
 
void unprojectPoint (const GeometryBuffer &buff, const Vector2 &p_in, Vector2 &p_out) const
 Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.
 
- Public Member Functions inherited from CEGUI::RenderTarget
virtual ~RenderTarget ()
 Destructor.
 

Protected Member Functions

void initialisePBuffer ()
 Initialise the PBuffer with the needed size.
 
void releasePBuffer ()
 Cleans up the pbuffer resources.
 
void enablePBuffer () const
 Switch rendering so it targets the pbuffer.
 
void disablePBuffer () const
 Switch rendering to target what was active before the pbuffer was used.
 
void initialiseTexture ()
 Perform basic initialisation of the texture we're going to use.
 
- Protected Member Functions inherited from CEGUI::OpenGLRenderTarget
virtual void updateMatrix () const
 helper that initialises the cached matrix
 

Protected Attributes

int d_pixfmt
 Holds the pixel format we use when creating the pbuffer.
 
HPBUFFERARB d_pbuffer
 Handle to the pbuffer itself.
 
HGLRC d_context
 Handle to the rendering context for the pbuffer.
 
HDC d_hdc
 Handle to the Windows device context for the pbuffer.
 
HGLRC d_prevContext
 Handle to the rendering context in use when we switched to the pbuffer.
 
HDC d_prevDC
 Handle to the device context in use when we switched to the pbuffer.
 
GLuint d_texture
 Associated OpenGL texture ID.
 
OpenGLTextured_CEGUITexture
 we use this to wrap d_texture so it can be used by the core CEGUI lib.
 
- Protected Attributes inherited from CEGUI::OpenGLRenderTarget
OpenGLRendererd_owner
 OpenGLRenderer that created this object.
 
Rect d_area
 holds defined area for the RenderTarget
 
double d_matrix [16]
 saved copy of projection matrix
 
bool d_matrixValid
 true if saved matrix is up to date
 
double d_viewDistance
 tracks viewing distance (this is set up at the same time as d_matrix)
 

Static Protected Attributes

static const float DEFAULT_SIZE
 default size of created texture objects
 
- Static Protected Attributes inherited from CEGUI::OpenGLRenderTarget
static const double d_yfov_tan
 tangent of the y FOV half-angle; used to calculate viewing distance.
 

Detailed Description

OpenGLWGLPBTextureTarget - allows rendering to an OpenGL texture via the pbuffer WGL extension.

Member Function Documentation

void CEGUI::OpenGLWGLPBTextureTarget::activate ( )
virtual

Activate the render target and put it in a state ready to be drawn to.

Note
You MUST call this before doing any rendering - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Reimplemented from CEGUI::OpenGLRenderTarget.

void CEGUI::OpenGLWGLPBTextureTarget::deactivate ( )
virtual

Deactivate the render target after having completed rendering.

Note
You MUST call this after you finish rendering to the target - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Reimplemented from CEGUI::OpenGLRenderTarget.

void CEGUI::OpenGLWGLPBTextureTarget::declareRenderSize ( const Size sz)
virtual

Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations.

Note
The main purpose of this is to allow for the implemenatation to resize the underlying texture so that it can hold the imagery that will be drawn.
Parameters
szSize object describing the largest area that will be rendererd in the next batch of rendering operations.
Exceptions
InvalidRequestExceptionMay be thrown if the TextureTarget would not be able to handle the operations rendering content of the given size.

Implements CEGUI::TextureTarget.

Texture& CEGUI::OpenGLWGLPBTextureTarget::getTexture ( ) const
virtual

Return a pointer to the CEGUI::Texture that the TextureTarget is using.

Returns
Texture object that the TextureTarget uses when rendering imagery.

Implements CEGUI::TextureTarget.

bool CEGUI::OpenGLWGLPBTextureTarget::isImageryCache ( ) const
virtual

Return whether the RenderTarget is an implementation that caches actual rendered imagery.

Typically it is expected that texture based RenderTargets would return
true in response to this call.  Other types of RenderTarget, like
view port based targets, will more likely return false.
Returns

Implements CEGUI::RenderTarget.

bool CEGUI::OpenGLWGLPBTextureTarget::isRenderingInverted ( ) const
virtual

Return whether rendering done on the target texture is inverted in relation to regular textures.

This is intended to be used when generating geometry for rendering the
TextureTarget onto another surface.
Returns
  • true if the texture content should be considered as inverted vertically in comparison with other regular textures.
  • false if the texture content has the same orientation as regular textures.

Implements CEGUI::TextureTarget.