GL helper functions and classes.

Collaboration diagram for GL helper functions and classes.:

Classes

class  CVD::VideoDisplay

Modules

 OpenGL text rendering

Functions

void CVD::glColor (const CVD::Rgba< float > &c)
void CVD::glColor (const CVD::Rgba< unsigned char > &c)
void CVD::glColor (const CVD::Rgb< float > &c)
void CVD::glColor (const CVD::Rgb< byte > &c)
void CVD::glColor3 (const CVD::Rgb8 &c)
void CVD::glColor4 (const CVD::Rgb8 &c)
template<class C >
void CVD::glDrawPixels (const SubImage< C > &i)
template<class P1 , class P2 >
void CVD::glLine (const P1 &x1, const P2 &x2)
void CVD::glPrintErrors (void)
void CVD::glRasterPos (const ImageRef &i)
template<class C >
Image< C > CVD::glReadPixels (ImageRef size, ImageRef origin=ImageRef(0, 0))
template<class C >
void CVD::glReadPixels (BasicImage< C > &i, ImageRef origin=ImageRef(0, 0))
void CVD::glRect (const ImageRef &p, const ImageRef &q)
void CVD::glTexCoord (const ImageRef &i)
template<class C >
void CVD::glTexImage2D (const SubImage< C > &i, GLint border=0, GLenum target=GL_TEXTURE_2D, GLint level=0)
template<class C >
void CVD::glTexSubImage2D (const SubImage< C > &i, GLint xoffset=0, GLint yoffset=0, GLenum target=GL_TEXTURE_2D, GLint level=0)
template<class C >
void CVD::glVertex (const C &list)
void CVD::glVertex (const ImageRef &i)

Detailed Description

Overloaded versions of GL functions to use CVD classes and datatypes, and other helpful GL classes and functions.


Function Documentation

void CVD::glColor ( const CVD::Rgba< float > &  c  )  [inline]

Set the new colour to the red, green, blue and alpha components given (where 0.0 represents zero intensity and 1.0 full intensity)

Parameters:
c The new colour

Definition at line 511 of file gl_helpers.h.

void CVD::glColor ( const CVD::Rgba< unsigned char > &  c  )  [inline]

Set the new colour to the red, green, blue and alpha components given (where 0 represents zero intensity and 255 full intensity)

Parameters:
c The new colour

Definition at line 502 of file gl_helpers.h.

void CVD::glColor ( const CVD::Rgb< float > &  c  )  [inline]

Set the new colour to the red, green and blue components given (where 0.0 represents zero intensity and 1.0 full intensity)

Parameters:
c The new colour

Definition at line 475 of file gl_helpers.h.

void CVD::glColor ( const CVD::Rgb< byte > &  c  )  [inline]

Set the new colour to the red, green, blue components given (where 0 represents zero intensity and 255 full intensity)

Parameters:
c The new colour

Definition at line 466 of file gl_helpers.h.

void CVD::glColor3 ( const CVD::Rgb8 c  )  [inline]

Set the new colour to the red, green and blue components given (where 0.0 represents zero intensity and 1.0 full intensity). The Rgb8::dummy member is ignored

Parameters:
c The new colour

Definition at line 484 of file gl_helpers.h.

void CVD::glColor4 ( const CVD::Rgb8 c  )  [inline]

Set the new colour to the red, green, blue and alpha components given (where 0.0 represents zero intensity and 1.0 full intensity)

Parameters:
c The new colour

Definition at line 493 of file gl_helpers.h.

template<class C >
void CVD::glDrawPixels ( const SubImage< C > &  i  )  [inline]

Draw an image to the frame buffer at the current raster position. Use glRasterPos to set the current raster position

Parameters:
i The image to draw

Definition at line 520 of file gl_helpers.h.

template<class P1 , class P2 >
void CVD::glLine ( const P1 &  x1,
const P2 &  x2 
) [inline]

draws a line from x1 to x2 any type that is accepted by glVertex is possible

Definition at line 445 of file gl_helpers.h.

void CVD::glPrintErrors ( void   )  [inline]

Prints the current errors on the gl error stack

Definition at line 574 of file gl_helpers.h.

void CVD::glRasterPos ( const ImageRef &  i  )  [inline]

Specify the (x,y) co-ordinates of the current raster position

Parameters:
i The raster position

Definition at line 72 of file gl_helpers.h.

template<class C >
Image<C> CVD::glReadPixels ( ImageRef  size,
ImageRef  origin = ImageRef(0,0) 
) [inline]

Read the current image from the colour buffer specified by glReadBuffer

Parameters:
size The size of the area to read.
origin The window co-ordinate of the first pixel to be read from the frame buffer

Definition at line 541 of file gl_helpers.h.

template<class C >
void CVD::glReadPixels ( BasicImage< C > &  i,
ImageRef  origin = ImageRef(0,0) 
) [inline]

Read the current image from the colour buffer specified by glReadBuffer

Parameters:
i The image to write the image data into. This must already be initialised to be an BasicImage (or Image) of the right size.
origin The window co-ordinate of the first pixel to be read from the frame buffer

Definition at line 532 of file gl_helpers.h.

void CVD::glRect ( const ImageRef &  p,
const ImageRef &  q 
) [inline]

Draws a rectangle by specifing two opposing vertices

Parameters:
p the first vertex
q the second vertex

Definition at line 81 of file gl_helpers.h.

void CVD::glTexCoord ( const ImageRef &  i  )  [inline]

Specify the (s,t) texture co-ordinates

Parameters:
i The texture coordinates

Definition at line 54 of file gl_helpers.h.

template<class C >
void CVD::glTexImage2D ( const SubImage< C > &  i,
GLint  border = 0,
GLenum  target = GL_TEXTURE_2D,
GLint  level = 0 
) [inline]

Sets an image as a texture. note the reordering of the various parameters to make better use of default parameters

Parameters:
i the image to set as texture

Definition at line 564 of file gl_helpers.h.

template<class C >
void CVD::glTexSubImage2D ( const SubImage< C > &  i,
GLint  xoffset = 0,
GLint  yoffset = 0,
GLenum  target = GL_TEXTURE_2D,
GLint  level = 0 
) [inline]

Sets an image as a texture sub region. note the reordering of the various parameters to make better use of default parameters

Parameters:
i the image to set as texture

Definition at line 552 of file gl_helpers.h.

template<class C >
void CVD::glVertex ( const C &  list  )  [inline]

sets a whole list of vertices stored in a std::vector. It uses the various glVertex helpers defined in this header file.

Parameters:
list the list of vertices

Definition at line 456 of file gl_helpers.h.

void CVD::glVertex ( const ImageRef &  i  )  [inline]

Specify the (x,y) co-ordinates of a vertex

Parameters:
i The vertex location

Definition at line 46 of file gl_helpers.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


libcvd
Author(s): Edward Rosten, Paul Smith, Tom Drummond, Gerhard Reitmayr, Ethan Eade, Timothy Gan, Chris Kemp, Georg Klein
autogenerated on Fri Jan 11 09:13:34 2013