---

CL_Display Class Reference

#include <display.h>

Inheritance diagram for CL_Display:

[legend]Collaboration diagram for CL_Display:

[legend]List of all members.

Public Methods
virtual	~CL_Display ()
Static Public Methods
void	flip_display (bool sync=false)
void	put_display (const CL_Rect &rect)
	param: sync - VSync on/off.
void	sync_buffers ()
void	clear_display (float red=0, float green=0, float blue=0, float alpha=1)
void	set_palette (CL_Palette *palette)
	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.
CL_Palette*	get_palette ()
	param: palette - Palette to use as new system palette.
void	select_card (CL_DisplayCard *card)
	retval: The system palette.
CL_DisplayCard*	get_current_card ()
	param: card - new selected display card.
void	set_videomode (CL_VidMode *mode)
	retval: Current display card.
void	set_videomode (int width, int height, int bpp, bool fullscreen=true, bool allow_resize=false, bool video_memory=true)
	param: mode - videomode to be changed to.also: CL_VidMode - Video mode description class.
CL_Target*	get_target ()
	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.
int	get_width ()
	retval: NULL or the framebuffer.
int	get_height ()
	retval: Width of current video mode.
int	get_bpp ()
	retval: Height of current video mode.
void	push_clip_rect ()
void	push_clip_rect (const CL_ClipRect &rect)
CL_ClipRect	get_clip_rect ()
	param: rect - The new clipping rectangle to be with the old one and then used.
void	set_clip_rect (const CL_ClipRect &rect)
	retval: The current clipping rectangle.
void	pop_clip_rect ()
void	push_translate_offset ()
void	push_translate_offset (int x, int y)
int	get_translate_offset_x ()
int	get_translate_offset_y ()
void	set_translate_offset (int x, int y)
void	pop_translate_offset ()
void	draw_rect (int x1, int y1, int x2, int y2, float r, float g, float b, float a=1.0f)
void	fill_rect (int x1, int y1, int x2, int y2, float r, float g, float b, float a=1.0f)
	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.
void	draw_line (int x1, int y1, int x2, int y2, float r, float g, float b, float a=1.0f)
	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.
void	fill_rect (int x1, int y1, int x2, int y2, CL_Surface *fill_surface, int focus_x=0, int focus_y=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.
CL_Signal_v2<int, int>&	get_sig_resize ()
	param: x1 - Leftmost x-coordinate.param: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: fill_surface - surface used to fill the area (tiled)param: focus_x - destination x offset used to offset (0, 0) in fill_surface (controls tiling position)param: focus_y - destination y offset used to offset (0, 0) in fill_surface (controls tiling position).
CL_Signal_v1<const CL_Rect &>&	get_sig_paint ()
Static Public Attributes
std::vector<CL_DisplayCard*>	cards
	retval: Depth of current video mode.

---

Constructor & Destructor Documentation

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

Definition at line 55 of file Display/Display/display.h.

---

Member Function Documentation

void CL_Display::clear_display ( float red = 0, float green = 0, float blue = 0, float alpha = 1 ) [static]

Referenced by toluaI_CL_Display_clear_display0().

void CL_Display::draw_line ( int x1, int y1, int x2, int y2, float r, float g, float b, float a = 1.0f ) [static]

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. Referenced by toluaI_CL_Display_draw_line0().

void CL_Display::draw_rect ( int x1, int y1, int x2, int y2, float r, float g, float b, float a = 1.0f ) [static]

void CL_Display::fill_rect ( int x1, int y1, int x2, int y2, CL_Surface * fill_surface, int focus_x = 0, int focus_y = 0 ) [static]

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.

void CL_Display::fill_rect ( int x1, int y1, int x2, int y2, float r, float g, float b, float a = 1.0f ) [static]

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. Referenced by toluaI_CL_Display_fill_rect0().

void CL_Display::flip_display ( bool sync = false ) [static]

Referenced by toluaI_CL_Display_flip_display0().

int CL_Display::get_bpp ( ) [static]

retval: Height of current video mode. Referenced by toluaI_CL_Display_get_bpp0().

CL_ClipRect CL_Display::get_clip_rect ( ) [static]

param: rect - The new clipping rectangle to be with the old one and then used. Referenced by toluaI_CL_Display_get_clip_rect0().

CL_DisplayCard* CL_Display::get_current_card ( ) [static]

param: card - new selected display card. Referenced by CL_Surface_Generic::ensure_surface_prepared(), and toluaI_CL_Display_get_current_card0().

int CL_Display::get_height ( ) [static]

retval: Width of current video mode. Referenced by toluaI_CL_Display_get_height0().

CL_Palette* CL_Display::get_palette ( ) [static]

param: palette - Palette to use as new system palette. Referenced by CL_SurfaceProvider_32bpp::CL_SurfaceProvider_32bpp(), and toluaI_CL_Display_get_palette0().

CL_Signal_v1<const CL_Rect &>& CL_Display::get_sig_paint ( ) [static]

CL_Signal_v2<int, int>& CL_Display::get_sig_resize ( ) [static]

param: x1 - Leftmost x-coordinate.param: y1 - Upper y-coordinate.param: x2 - Rightmost x-coordinate.param: y2 - Lower y-coordinate.param: fill_surface - surface used to fill the area (tiled)param: focus_x - destination x offset used to offset (0, 0) in fill_surface (controls tiling position)param: focus_y - destination y offset used to offset (0, 0) in fill_surface (controls tiling position).

CL_Target* CL_Display::get_target ( ) [static]

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.

int CL_Display::get_translate_offset_x ( ) [static]

int CL_Display::get_translate_offset_y ( ) [static]

int CL_Display::get_width ( ) [static]

retval: NULL or the framebuffer. Referenced by toluaI_CL_Display_get_width0().

void CL_Display::pop_clip_rect ( ) [static]

Referenced by toluaI_CL_Display_pop_clip_rect0().

void CL_Display::pop_translate_offset ( ) [static]

void CL_Display::push_clip_rect ( const CL_ClipRect & rect ) [static]

void CL_Display::push_clip_rect ( ) [static]

Referenced by toluaI_CL_Display_push_clip_rect0(), and toluaI_CL_Display_push_clip_rect1().

void CL_Display::push_translate_offset ( int x, int y ) [static]

void CL_Display::push_translate_offset ( ) [static]

void CL_Display::put_display ( const CL_Rect & rect ) [static]

param: sync - VSync on/off.

void CL_Display::select_card ( CL_DisplayCard * card ) [static]

retval: The system palette. Referenced by toluaI_CL_Display_select_card0().

void CL_Display::set_clip_rect ( const CL_ClipRect & rect ) [static]

retval: The current clipping rectangle. Referenced by toluaI_CL_Display_set_clip_rect0().

void CL_Display::set_palette ( CL_Palette * palette ) [static]

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. Referenced by toluaI_CL_Display_set_palette0().

void CL_Display::set_translate_offset ( int x, int y ) [static]

void CL_Display::set_videomode ( int width, int height, int bpp, bool fullscreen = true, bool allow_resize = false, bool video_memory = true ) [static]

param: mode - videomode to be changed to.also: CL_VidMode - Video mode description class.

void CL_Display::set_videomode ( CL_VidMode * mode ) [static]

retval: Current display card. Referenced by toluaI_CL_Display_set_videomode0(), and toluaI_CL_Display_set_videomode1().

void CL_Display::sync_buffers ( ) [static]

Referenced by toluaI_CL_Display_sync_buffers0().

---

Member Data Documentation

std::vector<CL_DisplayCard*> CL_Display::cards [static]

retval: Depth of current video mode. Definition at line 132 of file Display/Display/display.h.

---

The documentation for this class was generated from the following file:

• Display/Display/display.h

---