Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members  

CL_DisplayCard Class Reference

#include <displaycard.h>

Inheritance diagram for CL_DisplayCard:

Inheritance graph
[legend]
List of all members.

Public Methods

virtual const std::list<CL_VidMode*>& get_videomodes ()=0
virtual std::string get_name ()=0
 retval: Returns the list of videomodes.

virtual int get_total_memory ()=0
 retval: Returns the card name.

virtual int get_card_no ()=0
 retval: Videomemory available, or -1 if unknown.

virtual ~CL_DisplayCard ()
 retval: Card number.

virtual void flip_display (bool sync=false)=0
virtual void put_display (const class CL_Rect &rect)=0
 param: sync - VSync on/off.

virtual void sync_buffers ()=0
virtual void clear_display (float red=0, float green=0, float blue=0, float alpha=1)=0
virtual void set_palette (CL_Palette *palette)=0
 param: red - red component of the color.param: green - green component of the color.param: blue - blue component of the color.param: alpha - alpha (transparency) component of the color.

virtual CL_Palette* get_palette ()=0
 param: palette - Palette to use as new system palette.

virtual void set_videomode (CL_VidMode *mode)
 retval: The system palette.

virtual void set_videomode (int width, int height, int bpp, bool fullscreen=true, bool allow_resize=false, bool video_memory=true)=0
 param: mode - videomode to be changed to.

virtual bool is_initialized ()=0
 param: width - width in pixels of the new video mode.param: height - height in pixels of the new video mode.param: bpp - Bits per pixel. The depth of the new video mode. (8, 16, 24, 32)param: video_memory - Use video memory if possible. System memory may be faster if alpha blending is used a lot.

virtual CL_Target* get_target ()=0
 retval: true if initialized.

virtual int get_width ()=0
virtual int get_height ()=0
 retval: Width of video mode.

virtual int get_bpp ()=0
 retval: Height of video mode.

virtual void push_clip_rect ()=0
 retval: Depth of video mode.

virtual void push_clip_rect (const CL_ClipRect &rect)=0
virtual CL_ClipRect get_clip_rect ()=0
 param: rect - The new clipping rectangle to be with the old one and then used.

virtual void set_clip_rect (const CL_ClipRect &rect)=0
 retval: The current clipping rectangle.

virtual void pop_clip_rect ()=0
virtual void push_translate_offset ()=0
virtual void push_translate_offset (int x, int y)=0
virtual int get_translate_offset_x ()=0
virtual int get_translate_offset_y ()=0
virtual void set_translate_offset (int x, int y)=0
virtual void pop_translate_offset ()=0
virtual void fill_rect (int x1, int y1, int x2, int y2, float r, float g, float b, float a)=0
virtual void draw_rect (int x1, int y1, int x2, int y2, float r, float g, float b, float a)=0
 param: x1 - Leftmost x-coordinate.param: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: r - Red component of the filled color.param: g - Green component of the filled color.param: b - Blue component of the filled color.param: a - Alpha component of the filled color.

virtual void draw_line (int x1, int y1, int x2, int y2, float r, float g, float b, float a)=0
 param: x1 - Leftmost x-coordinate.param: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: r - Red component of the filled color.param: g - Green component of the filled color.param: b - Blue component of the filled color.param: a - Alpha component of the filled color.

virtual CL_Signal_v2<int,
int>& 		get_sig_resize ()=0
 param: x1 - Leftmost x-coordinate. //FIXMEparam: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: r - Red component of the filled color.param: g - Green component of the filled color.param: b - Blue component of the filled color.param: a - Alpha component of the filled color.

virtual CL_Signal_v1<const
CL_Rect &>& 		get_sig_paint ()=0

Constructor & Destructor Documentation

CL_DisplayCard::~CL_DisplayCard ( ) [inline, virtual]
 

retval: Card number.

Definition at line 61 of file displaycard.h.

Member Function Documentation

virtual void CL_DisplayCard::clear_display ( float red = 0,
float green = 0,
float blue = 0,
float alpha = 1 ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Generic.

void CL_DisplayCard::draw_line ( int x1,
int y1,
int x2,
int y2,
float r,
float g,
float b,
float a ) [pure virtual]
 

param: x1 - Leftmost x-coordinate.param: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: r - Red component of the filled color.param: g - Green component of the filled color.param: b - Blue component of the filled color.param: a - Alpha component of the filled color.

Reimplemented in CL_DisplayCard_Generic.

void CL_DisplayCard::draw_rect ( int x1,
int y1,
int x2,
int y2,
float r,
float g,
float b,
float a ) [pure virtual]
 

param: x1 - Leftmost x-coordinate.param: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: r - Red component of the filled color.param: g - Green component of the filled color.param: b - Blue component of the filled color.param: a - Alpha component of the filled color.

Reimplemented in CL_DisplayCard_Be, and CL_DisplayCard_Generic.

virtual void CL_DisplayCard::fill_rect ( int x1,
int y1,
int x2,
int y2,
float r,
float g,
float b,
float a ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Generic.

virtual void CL_DisplayCard::flip_display ( bool sync = false ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

int CL_DisplayCard::get_bpp ( ) [pure virtual]
 

retval: Height of video mode.

Reimplemented in CL_DisplayCard_Generic.

int CL_DisplayCard::get_card_no ( ) [pure virtual]
 

retval: Videomemory available, or -1 if unknown.

Reimplemented in CL_DisplayCard_Generic.

Referenced by CL_Surface_Generic::ensure_surface_prepared().

CL_ClipRect CL_DisplayCard::get_clip_rect ( ) [pure virtual]
 

param: rect - The new clipping rectangle to be with the old one and then used.

Reimplemented in CL_DisplayCard_Generic.

int CL_DisplayCard::get_height ( ) [pure virtual]
 

retval: Width of video mode.

Reimplemented in CL_DisplayCard_Generic.

std::string CL_DisplayCard::get_name ( ) [pure virtual]
 

retval: Returns the list of videomodes.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

CL_Palette * CL_DisplayCard::get_palette ( ) [pure virtual]
 

param: palette - Palette to use as new system palette.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

virtual CL_Signal_v1<const CL_Rect &>& CL_DisplayCard::get_sig_paint ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

CL_Signal_v2< int, int > & CL_DisplayCard::get_sig_resize ( ) [pure virtual]
 

param: x1 - Leftmost x-coordinate. //FIXMEparam: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: r - Red component of the filled color.param: g - Green component of the filled color.param: b - Blue component of the filled color.param: a - Alpha component of the filled color.

Reimplemented in CL_DisplayCard_Generic.

CL_Target * CL_DisplayCard::get_target ( ) [pure virtual]
 

retval: true if initialized.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

Referenced by CL_DisplayCard_Generic::get_translate_offset_x(), CL_DisplayCard_Generic::get_translate_offset_y(), CL_DisplayCard_Generic::pop_clip_rect(), CL_DisplayCard_Generic::pop_translate_offset(), CL_DisplayCard_Generic::push_clip_rect(), CL_DisplayCard_Generic::push_translate_offset(), CL_DisplayCard_Generic::set_clip_rect(), and CL_DisplayCard_Generic::set_translate_offset().

int CL_DisplayCard::get_total_memory ( ) [pure virtual]
 

retval: Returns the card name.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

virtual int CL_DisplayCard::get_translate_offset_x ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

virtual int CL_DisplayCard::get_translate_offset_y ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

virtual const std::list<CL_VidMode*>& CL_DisplayCard::get_videomodes ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

virtual int CL_DisplayCard::get_width ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

bool CL_DisplayCard::is_initialized ( ) [pure virtual]
 

param: width - width in pixels of the new video mode.param: height - height in pixels of the new video mode.param: bpp - Bits per pixel. The depth of the new video mode. (8, 16, 24, 32)param: video_memory - Use video memory if possible. System memory may be faster if alpha blending is used a lot.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

virtual void CL_DisplayCard::pop_clip_rect ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

virtual void CL_DisplayCard::pop_translate_offset ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

virtual void CL_DisplayCard::push_clip_rect ( const CL_ClipRect & clip ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

void CL_DisplayCard::push_clip_rect ( ) [pure virtual]
 

retval: Depth of video mode.

Reimplemented in CL_DisplayCard_Generic.

Referenced by CL_DisplayCard_Generic::push_clip_rect().

virtual void CL_DisplayCard::push_translate_offset ( int x,
int y ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

virtual void CL_DisplayCard::push_translate_offset ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

void CL_DisplayCard::put_display ( const class CL_Rect & rect ) [pure virtual]
 

param: sync - VSync on/off.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

void CL_DisplayCard::set_clip_rect ( const CL_ClipRect & clip ) [pure virtual]
 

retval: The current clipping rectangle.

Reimplemented in CL_DisplayCard_Generic.

Referenced by CL_DisplayCard_Generic::set_resize().

void CL_DisplayCard::set_palette ( CL_Palette * palette ) [pure virtual]
 

param: red - red component of the color.param: green - green component of the color.param: blue - blue component of the color.param: alpha - alpha (transparency) component of the color.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

virtual void CL_DisplayCard::set_translate_offset ( int x,
int y ) [pure virtual]
 

Reimplemented in CL_DisplayCard_Generic.

void CL_DisplayCard::set_videomode ( int width,
int height,
int bpp,
bool fullscreen = true,
bool allow_resize = false,
bool video_memory = true ) [pure virtual]
 

param: mode - videomode to be changed to.

Reimplemented in CL_DisplayCard_Be, CL_DisplayCard_DirectDraw, and CL_DisplayCard_Svgalib.

void CL_DisplayCard::set_videomode ( CL_VidMode * mode ) [virtual]
 

retval: The system palette.

virtual void CL_DisplayCard::sync_buffers ( ) [pure virtual]
 

Reimplemented in CL_DisplayCard_DirectDraw, and CL_DisplayCard_Generic.

The documentation for this class was generated from the following file:
Generated at Wed Apr 4 19:56:51 2001 for ClanLib by doxygen1.2.6 written by Dimitri van Heesch, © 1997-2001