regcom::gui::Surface

Surface Class Reference

#include <Surface.h>

Inheritance diagram for Surface:

List of all members.


Public Member Functions
	Surface ()
	(* add brief description here *)
virtual	~Surface ()
	(* add brief description here *)
int	Create (int w, int h)
	(* add brief description here *)
int	Load (const std::string &rPath, const std::string &rName)
	(* add brief description here *)
int	Load (const std::string &rName)
	(* add brief description here *)
int	SetColorKey (int r, int g, int b)
	(* add brief description here *)
int	DisplayFormat ()
	(* add brief description here *)
int	DisplayFormatAlpha ()
	(* add brief description here *)
int	Blit (Surface surface, Rect src, int x, int y)
	(* add brief description here *)
int	LowerBlit (Surface surface, Rect src, int x, int y)
	(* add brief description here *)
int	FillRect (const Rect &rRect, const Color &rColor)
	(* add brief description here *)
int	Transparent (int x, int y)
	(* add brief description here *)
Uint32	GetPixel (int x, int y)
	(* add brief description here *)
int	Width ()
	(* add brief description here *)
int	Height ()
	(* add brief description here *)
int	Depth ()
	(* add brief description here *)
int	Pitch ()
	(* add brief description here *)
void *	Pixels ()
	(* add brief description here *)
int	Lock ()
	(* add brief description here *)
int	Unlock ()
	(* add brief description here *)
int	GetPalette (Surface *surface)
	(* add brief description here *)
void	SetSurface (SDL_Surface *pSurface)
	Sets surface.
Uint32	MapRGB (Uint8 red, Uint8 green, Uint8 blue) const
	(* add brief description here *)
Uint32	MapRGBA (Uint8 red, Uint8 green, Uint8 blue, Uint8 alpha) const
	(* add brief description here *)
Protected Attributes
SDL_Surface *	m_pSurface
	(* add brief description here *)

Detailed Description

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Constructor & Destructor Documentation

Surface ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

~Surface ( ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Member Function Documentation

int Create	(	int	w,
		int	h
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Load	(	const std::string &	rPath,
		const std::string &	rName
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Load ( const std::string & rName )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int SetColorKey	(	int	r,
		int	g,
		int	b
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int DisplayFormat ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int DisplayFormatAlpha ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Blit	(	Surface *	surface,
		Rect *	src,
		int	x,
		int	y
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int LowerBlit	(	Surface *	surface,
		Rect *	src,
		int	x,
		int	y
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int FillRect	(	const Rect &	rRect,
		const Color &	rColor
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Transparent	(	int	x,
		int	y
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Uint32 GetPixel	(	int	x,
		int	y
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Width ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Height ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Depth ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Pitch ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void * Pixels ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Lock ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int Unlock ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

int GetPalette ( Surface * surface )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void SetSurface ( SDL_Surface * pSurface ) [inline]

Sets surface.

Uint32 MapRGB	(	Uint8	red,
		Uint8	green,
		Uint8	blue
	)			const `[inline]`

(*** add brief description here ***)

Uint32 MapRGBA	(	Uint8	red,
		Uint8	green,
		Uint8	blue,
		Uint8	alpha
	)			const `[inline]`

(*** add brief description here ***)

Member Data Documentation

SDL_Surface* m_pSurface [protected]

(*** add brief description here ***)

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