csGraphics2DGLCommon Class Reference
Basic OpenGL version of the 2D driver class You can look at the openGLX graphics class as an example of how to inherit and use this class. More...
#include <csplugincommon/opengl/glcommon2d.h>
Public Types | |
typedef int | GLPixelFormat [glpfvValueCount] |
enum | GLPixelFormatValue |
Public Member Functions | |
virtual bool | BeginDraw () |
This routine should be called before any draw operations. | |
virtual void | Blit (int x, int y, int w, int h, unsigned char const *data) |
Blit. | |
virtual void | Clear (int color) |
Clear the screen with color. | |
csGraphics2DGLCommon (iBase *iParent) | |
Constructor does little, most initialization stuff happens in Initialize(). | |
virtual bool | DebugCommand (const char *cmd) |
Execute a debug command. | |
virtual bool | DoubleBuffer (bool Enable) |
Enable or disable double buffering; returns success status. | |
virtual void | DrawBox (int x, int y, int w, int h, int color) |
Draw a box. | |
virtual void | DrawLine (float x1, float y1, float x2, float y2, int color) |
Draw a line. | |
virtual void | DrawPixel (int x, int y, int color) |
Draw a pixel. | |
virtual void | DrawPixels (csPixelCoord const *pixels, int num_pixels, int color) |
Draw a series of pixels. | |
virtual int | FindRGB (int r, int g, int b, int a=255) |
virtual void | FinishDraw () |
This routine should be called when you finished drawing. | |
virtual bool | GetDoubleBufferState () |
Get the double buffer state. | |
virtual int | GetHeight () |
virtual unsigned char * | GetPixelAt (int x, int y) |
Get address of video RAM at given x,y coordinates. | |
virtual void | GetRGB (int color, int &r, int &g, int &b, int &a) |
virtual void | GetRGB (int color, int &r, int &g, int &b) |
virtual int | GetWidth () |
virtual bool | Initialize (iObjectRegistry *object_reg) |
Initialize the plugin. | |
virtual bool | Open () |
Initialize font cache, texture cache, prints renderer name and version. | |
virtual bool | PerformExtensionV (char const *command, va_list) |
Perform extension commands. | |
virtual bool | Resize (int width, int height) |
Resize the canvas. | |
virtual void | RestoreArea (csImageArea *Area, bool Free=true) |
Restore a subarea of screen saved with SaveArea(). | |
virtual csImageArea * | SaveArea (int x, int y, int w, int h) |
Save a subarea of screen area into the variable Data. | |
virtual csPtr< iImage > | ScreenShot () |
Do a screenshot: return a new iImage object. | |
virtual void | SetRGB (int i, int r, int g, int b) |
Set a palette entry. | |
virtual | ~csGraphics2DGLCommon () |
Clear font cache etc. | |
iEventPlug implementation | |
virtual unsigned | GetPotentiallyConflictingEvents () |
virtual unsigned | QueryEventPriority (unsigned) |
iGLDriverDatabase implementation | |
void | ReadDatabase (iDocumentNode *dbRoot, int configPriority=iConfigManager::ConfigPriorityPlugin+20, const char *phase=0) |
Public Attributes | |
csRef< iEventOutlet > | EventOutlet |
The event plug object. | |
Protected Member Functions | |
void | DecomposeColor (int iColor, float &oR, float &oG, float &oB, float &oA) |
Same but uses floating-point format. | |
void | DecomposeColor (int iColor, GLubyte &oR, GLubyte &oG, GLubyte &oB, GLubyte &oA) |
Decompose a color ID into r,g,b components. | |
void | OpenDriverDB (const char *phase=0) |
Open default driver database. | |
void | setGLColorfromint (int color) |
Set up current GL RGB color from a packed color format. | |
Protected Attributes | |
GLPixelFormat | currentFormat |
Depth buffer resolution. | |
csGLDriverDatabase | driverdb |
Driver database. | |
csGLExtensionManager | ext |
Extension manager. | |
bool | hasRenderTarget |
bool | multiFavorQuality |
Whether to favor quality or speed. | |
uint8 * | screen_shot |
csGLScreenShot * | ssPool |
csGLStateCache * | statecache |
Cache for GL states. | |
csGLStateCacheContext * | statecontext |
bool | useCombineTE |
int | vpHeight |
bool | vpSet |
int | vpWidth |
Friends | |
class | csGLFontCache |
class | csGLPixelFormatPicker |
class | csGLScreenShot |
Classes | |
class | csGLPixelFormatPicker |
Detailed Description
Basic OpenGL version of the 2D driver class You can look at the openGLX graphics class as an example of how to inherit and use this class.In short, inherit from this common class instead of from csGraphics2D, and override all the functions you normally would except for the 2D drawing functions, which are supplied for you here. That way all OpenGL drawing functions are unified over platforms, so that a fix or improvement will be inherited by all platforms instead of percolating via people copying code over. -GJH
Definition at line 53 of file glcommon2d.h.
Constructor & Destructor Documentation
|
Constructor does little, most initialization stuff happens in Initialize().
|
|
Clear font cache etc.
|
Member Function Documentation
|
This routine should be called before any draw operations. It should return true if graphics context is ready. |
|
Blit.
|
|
Clear the screen with color.
|
|
Execute a debug command.
|
|
Same but uses floating-point format.
|
|
Decompose a color ID into r,g,b components.
|
|
Enable or disable double buffering; returns success status.
Definition at line 270 of file glcommon2d.h. |
|
Draw a box.
|
|
Draw a line.
|
|
Draw a pixel.
|
|
Draw a series of pixels.
|
|
This routine should be called when you finished drawing.
|
|
Get the double buffer state.
Definition at line 267 of file glcommon2d.h. |
|
Get address of video RAM at given x,y coordinates. The OpenGL version of this function just returns 0 if not doing a screenshot. |
|
Initialize the plugin.
|
|
Initialize font cache, texture cache, prints renderer name and version. you should still print out the 2D driver type (X, Win, etc.) in your subclass code. |
|
Open default driver database.
|
|
Perform extension commands.
|
|
Resize the canvas.
|
|
Restore a subarea of screen saved with SaveArea().
|
|
Save a subarea of screen area into the variable Data. Storage is allocated in this call, you should either FreeArea() it after usage or RestoreArea() it. |
|
Do a screenshot: return a new iImage object.
|
|
Set up current GL RGB color from a packed color format.
|
|
Set a palette entry.
|
Member Data Documentation
|
Depth buffer resolution.
Definition at line 132 of file glcommon2d.h. |
|
Driver database.
Definition at line 134 of file glcommon2d.h. |
|
The event plug object.
Definition at line 151 of file glcommon2d.h. |
|
Extension manager.
Definition at line 125 of file glcommon2d.h. |
|
Whether to favor quality or speed.
Definition at line 129 of file glcommon2d.h. |
|
Cache for GL states.
Definition at line 105 of file glcommon2d.h. |
The documentation for this class was generated from the following file:
- csplugincommon/opengl/glcommon2d.h
Generated for Crystal Space by doxygen 1.4.4