csGraphics2D Class Reference
[Common Plugin Classes]
This is the base class for 2D canvases.
More...
#include <csplugincommon/canvas/graph2d.h>
Public Member Functions | |
virtual void | AllowResize (bool) |
Enable/disable canvas resize (Over-ride in sub classes). | |
virtual bool | BeginDraw () |
This routine should be called before any draw operations. | |
virtual void | Blit (int x, int y, int width, int height, unsigned char const *data) |
Blit a memory block. Format of the image is RGBA in bytes. Row by row. | |
virtual void | ChangeDepth (int d) |
Change the depth of the canvas. | |
virtual void | Clear (int color) |
Clear backbuffer. | |
virtual void | ClearAll (int color) |
Clear all video pages. | |
virtual bool | ClipLine (float &x1, float &y1, float &x2, float &y2, int xmin, int ymin, int xmax, int ymax) |
Clip a line against given rectangle Function returns true if line is not visible. | |
virtual void | Close () |
(*) Close graphics system | |
csGraphics2D (iBase *) | |
Create csGraphics2D object. | |
virtual bool | DoubleBuffer (bool Enable) |
Enable or disable double buffering; return TRUE if supported. | |
virtual void | DrawBox (int x, int y, int w, int h, int color) |
Draw a box of given width and height. | |
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) |
Same but exposed through iGraphics2D interface. | |
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 void | FreeArea (csImageArea *Area) |
Free storage allocated for a subarea of screen. | |
virtual void | GetClipRect (int &xmin, int &ymin, int &xmax, int &ymax) |
Query clipping rectangle. | |
virtual bool | GetDoubleBufferState () |
Return current double buffering state. | |
virtual iFontServer * | GetFontServer () |
Gets the font server. | |
virtual bool | GetFullScreen () |
Returns 'true' if the program is being run full-screen. | |
virtual float | GetGamma () const |
virtual int | GetHeight () |
Return the height of the framebuffer. | |
virtual iNativeWindow * | GetNativeWindow () |
Return the Native Window interface for this canvas (if it has one). | |
virtual int | GetPage () |
Get active videopage number (starting from zero). | |
virtual int | GetPalEntryCount () |
Return the number of palette entries that can be modified. | |
virtual csRGBpixel * | GetPalette () |
Get the palette (if there is one). | |
virtual void | GetPixel (int x, int y, uint8 &oR, uint8 &oG, uint8 &oB, uint8 &oA) |
As GetPixel() above, but with alpha. | |
virtual void | GetPixel (int x, int y, uint8 &oR, uint8 &oG, uint8 &oB) |
Query pixel R,G,B at given screen location. | |
virtual unsigned char * | GetPixelAt (int x, int y) |
Same but exposed through iGraphics2D interface. | |
virtual int | GetPixelBytes () |
Return the number of bytes for every pixel. | |
virtual csPixelFormat const * | GetPixelFormat () |
Return information about about the pixel format. | |
virtual int | GetWidth () |
Return the width of the framebuffer. | |
virtual bool | HandleEvent (iEvent &) |
Event handler for plugin. | |
virtual bool | Initialize (iObjectRegistry *) |
Initialize the plugin. | |
virtual bool | Open () |
(*) Open graphics system (set videomode, open window etc) | |
virtual bool | PerformExtension (char const *command,...) |
Perform a system specific extension. | |
virtual bool | PerformExtensionV (char const *command, va_list) |
Perform a system specific extension. | |
virtual void | Print (csRect const *=0) |
(*) Flip video pages (or dump backbuffer into framebuffer). | |
virtual bool | Resize (int w, int h) |
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 | SetClipRect (int xmin, int ymin, int xmax, int ymax) |
Set clipping rectangle. | |
virtual void | SetFullScreen (bool b) |
Change the fullscreen state of the canvas. | |
virtual bool | SetGamma (float) |
virtual bool | SetMouseCursor (iImage *image, const csRGBcolor *keycolor=0, int hotspot_x=0, int hotspot_y=0, csRGBcolor fg=csRGBcolor(255, 255, 255), csRGBcolor bg=csRGBcolor(0, 0, 0)) |
Set mouse cursor using an image. | |
virtual bool | SetMouseCursor (csMouseCursorID iShape) |
Set mouse cursor to one of predefined shape classes (see csmcXXX enum above). | |
virtual bool | SetMousePosition (int x, int y) |
Set mouse cursor position; return success status. | |
virtual void | SetRGB (int i, int r, int g, int b) |
(*) Set a color index to given R,G,B (0..255) values | |
virtual void | Write (iFont *font, int x, int y, int fg, int bg, const char *text, uint flags=0) |
Write a text string into the back buffer. | |
virtual | ~csGraphics2D () |
Destroy csGraphics2D object. | |
Public Attributes | |
void(* | _DrawPixel )(csGraphics2D *This, int x, int y, int color) |
Draw a pixel. | |
unsigned char *(* | _GetPixelAt )(csGraphics2D *This, int x, int y) |
(*) Get address of video RAM at given x,y coordinates | |
bool | AllowResizing |
Whether to allow resizing. | |
int | ClipX1 |
The clipping rectangle. | |
int | ClipX2 |
int | ClipY1 |
int | ClipY2 |
csConfigAccess | config |
The configuration file. | |
int | Depth |
int | DisplayNumber |
Display number. | |
csFontCache * | fontCache |
The font cache. | |
csWeakRef< iFontServer > | FontServer |
The font server. | |
int | FrameBufferLocked |
The counter that is incremented inside BeginDraw and decremented in FinishDraw(). | |
bool | FullScreen |
True if visual is full-screen. | |
int | Height |
bool | is_open |
Open/Close state. | |
int * | LineAddress |
Keep a array of Y*width to avoid multiplications. | |
unsigned char * | Memory |
Most systems have a pointer to (real or pseudo) video RAM. | |
iObjectRegistry * | object_reg |
The object registry. | |
csRef< iOffscreenCanvasCallback > | ofscb |
Callback to use for informing an external agent when several canvas operations have occured. | |
csRGBpixel * | Palette |
256-color palette. | |
bool | PaletteAlloc [256] |
true if some palette entry is already allocated. | |
csPixelFormat | pfmt |
The pixel format. | |
csWeakRef< iPluginManager > | plugin_mgr |
The plugin manager. | |
int | Width |
The width, height and depth of visual. | |
char * | win_title |
Pointer to a title. | |
Protected Member Functions | |
iNativeWindowManager implementation | |
iDebugHelper implementation | |
virtual csTicks | Benchmark (int) |
virtual void | Dump (iGraphics3D *) |
virtual csPtr< iString > | Dump () |
virtual int | GetSupportedTests () const |
virtual csPtr< iString > | StateTest () |
virtual csPtr< iString > | UnitTest () |
iPluginConfig implementation | |
iNativeWindow implementation | |
Static Protected Member Functions | |
static void | DrawPixel16 (csGraphics2D *This, int x, int y, int color) |
Draw a pixel in 16-bit modes. | |
static void | DrawPixel32 (csGraphics2D *This, int x, int y, int color) |
Draw a pixel in 32-bit modes. | |
static void | DrawPixel8 (csGraphics2D *This, int x, int y, int color) |
Draw a pixel in 8-bit modes. | |
static unsigned char * | GetPixelAt16 (csGraphics2D *This, int x, int y) |
Return address of a 16-bit pixel. | |
static unsigned char * | GetPixelAt32 (csGraphics2D *This, int x, int y) |
Return address of a 32-bit pixel. | |
static unsigned char * | GetPixelAt8 (csGraphics2D *This, int x, int y) |
Return address of a 8-bit pixel. | |
Protected Attributes | |
int | refreshRate |
Screen refresh rate. | |
bool | vsync |
Activate Vsync. | |
Classes | |
struct | EventHandler |
Detailed Description
This is the base class for 2D canvases.Plugins should derive their own class from this one and implement required (marked with an asterisk (*)) functions. Functions not marked with an asterisk are optional, but possibly slow since they are too general.
Definition at line 58 of file graph2d.h.
Constructor & Destructor Documentation
|
Create csGraphics2D object.
|
|
Destroy csGraphics2D object.
|
Member Function Documentation
|
Enable/disable canvas resize (Over-ride in sub classes).
|
|
This routine should be called before any draw operations. It should return true if graphics context is ready. |
|
Blit a memory block. Format of the image is RGBA in bytes. Row by row.
|
|
Change the depth of the canvas.
|
|
Clear backbuffer.
|
|
Clear all video pages.
|
|
Clip a line against given rectangle Function returns true if line is not visible.
|
|
(*) Close graphics system
|
|
Enable or disable double buffering; return TRUE if supported.
|
|
Draw a box of given width and height.
|
|
Draw a line.
|
|
Same but exposed through iGraphics2D interface.
|
|
Draw a pixel in 16-bit modes.
|
|
Draw a pixel in 32-bit modes.
|
|
Draw a pixel in 8-bit modes.
|
|
This routine should be called when you finished drawing.
|
|
Free storage allocated for a subarea of screen.
|
|
Query clipping rectangle.
|
|
Return current double buffering state.
|
|
Gets the font server.
|
|
Returns 'true' if the program is being run full-screen.
|
|
Return the height of the framebuffer.
|
|
Return the Native Window interface for this canvas (if it has one).
|
|
Get active videopage number (starting from zero).
|
|
Return the number of palette entries that can be modified. This should return 0 if there is no palette (true color displays). This function is equivalent to the PalEntries field that you get from GetPixelFormat(). It is just a little bit easier to obtain this way. |
|
Get the palette (if there is one).
|
|
As GetPixel() above, but with alpha.
|
|
Query pixel R,G,B at given screen location.
|
|
Same but exposed through iGraphics2D interface.
Definition at line 242 of file graph2d.h. Referenced by csG2DDrawBox< Tpixel, Tpixmixer >::DrawBox(), csG2DDrawLine< Tpixel, Tpixmixer >::DrawLine(), and csG2DDrawText< Tpixel, Tpixmixer1, Tpixmixer2, Tpixmixer3 >::DrawText(). |
|
Return address of a 16-bit pixel.
|
|
Return address of a 32-bit pixel.
|
|
Return address of a 8-bit pixel.
|
|
Return the number of bytes for every pixel. This function is equivalent to the PixelBytes field that you get from GetPixelFormat(). |
|
Return information about about the pixel format.
|
|
Return the width of the framebuffer.
|
|
Event handler for plugin.
Referenced by csGraphics2D::EventHandler::HandleEvent(). |
|
Initialize the plugin.
|
|
(*) Open graphics system (set videomode, open window etc)
|
|
Perform a system specific extension. Return false if extension not supported. |
|
Perform a system specific extension. Return false if extension not supported. |
|
(*) Flip video pages (or dump backbuffer into framebuffer).
|
|
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 clipping rectangle.
|
|
Change the fullscreen state of the canvas.
|
|
Set mouse cursor using an image. If the operation is unsupported, return 'false' otherwise return 'true'. On some platforms there is only monochrome pointers available. In this all black colors in the image will become the value of 'bg' and all non-black colors will become 'fg' |
|
Set mouse cursor to one of predefined shape classes (see csmcXXX enum above). If a specific mouse cursor shape is not supported, return 'false'; otherwise return 'true'. If system supports it and iBitmap != 0, shape should be set to the bitmap passed as second argument; otherwise cursor should be set to its nearest system equivalent depending on iShape argument. |
|
Set mouse cursor position; return success status.
|
|
(*) Set a color index to given R,G,B (0..255) values
|
|
Write a text string into the back buffer.
|
Member Data Documentation
|
Draw a pixel. This allows deciding at run-time which function we will choose. |
|
(*) Get address of video RAM at given x,y coordinates
|
|
Whether to allow resizing.
|
|
The clipping rectangle.
|
|
The configuration file.
|
|
Display number. If 0, use primary display; else if greater than 0, use that display number. If that display number is not present, use primary display. |
|
The font cache.
|
|
The font server.
|
|
The counter that is incremented inside BeginDraw and decremented in FinishDraw().
|
|
True if visual is full-screen.
|
|
Open/Close state.
|
|
Keep a array of Y*width to avoid multiplications.
Definition at line 84 of file graph2d.h. Referenced by csG2DDrawLine< Tpixel, Tpixmixer >::DrawLine(). |
|
Most systems have a pointer to (real or pseudo) video RAM.
Definition at line 78 of file graph2d.h. Referenced by csG2DDrawLine< Tpixel, Tpixmixer >::DrawLine(). |
|
The object registry.
|
|
Callback to use for informing an external agent when several canvas operations have occured.
|
|
256-color palette.
|
|
true if some palette entry is already allocated.
|
|
The pixel format.
Definition at line 75 of file graph2d.h. Referenced by csPixMixerRGBA< Tpixel >::csPixMixerRGBA(). |
|
The plugin manager.
|
|
Screen refresh rate.
|
|
Activate Vsync.
|
|
The width, height and depth of visual.
|
|
Pointer to a title.
|
The documentation for this class was generated from the following file:
- csplugincommon/canvas/graph2d.h
Generated for Crystal Space by doxygen 1.4.4