SallyAPI::GUI::CPicture Class Reference

Picture. More...

#include <Picture.h>

List of all members.

Classes
struct	PANEL_CUSTOMVERTEX
Public Member Functions
	CPicture ()
	Default constructor.
	~CPicture ()
	Destructor.
SallyAPI::Core::CTexture *	GetTexture ()
	Gets the texture.
void	SetTexture (SallyAPI::Core::CTexture *texture)
	Sets a texture.
bool	CreateEmptyPixelFormat (int iWidth, int iHeight, Gdiplus::PixelFormat pixelFormat)
	Creates an empty pixel format.
bool	CreateEmptyD3DFormat (int iWidth, int iHeight, D3DFORMAT d3dFormat)
	Creates an empty d 3 d format.
bool	CreateEmptyAsRenderTargetD3DFormat (int iWidth, int iHeight, D3DFORMAT d3dFormat)
	Creates an empty as render target d 3 d format.
bool	LoadTexture (const std::string &fileName, bool createMipMaps=false)
	Loads a texture.
bool	LoadTextureOverGDI (const std::string &fileName, int width=-1, int height=-1)
	Loads a texture over gdi.
void	Draw (int x, int y)
	Draws.
void	Draw (int x, int y, int width, int height)
	Draws.
int	GetWidth ()
	Gets the width.
int	GetHeight ()
	Gets the height.
void	SetWidth (int width)
	Sets a width.
void	SetHeight (int height)
	Sets a height.
void	UpdateDimensions ()
	Updates the width and hight information.
void	SetAlphaBlending (int alphaBlending)
	Sets an alpha blending.
void	SetRotationAngleY (float angle)
	Sets a rotation angle y coordinate coordinate.
void	SetRotationAngleX (float angle)
	Sets a rotation angle x coordinate coordinate.
void	SetRotationAngleZ (float angle)
	Sets a rotation angle z coordinate coordinate.

---

Detailed Description

Picture.

Author:

Christian Knobloch

Date:

19.04.2010

---

Constructor & Destructor Documentation

CPicture::CPicture

(

)

Default constructor.

Author:

Christian Knobloch

Date:

19.04.2010

CPicture::~CPicture

(

)

Destructor.

Author:

Christian Knobloch

Date:

19.04.2010

---

Member Function Documentation

bool CPicture::CreateEmptyAsRenderTargetD3DFormat	(	int	iWidth,
		int	iHeight,
		D3DFORMAT	d3dFormat
	)

Creates an empty as render target d 3 d format.

Author:

Christian Knobloch

Date:

27.04.2010

Parameters:

iWidth	The width.
iHeight	The height.
d3dFormat	The 3d format.

Returns:

true if it succeeds, false if it fails.

bool CPicture::CreateEmptyD3DFormat	(	int	iWidth,
		int	iHeight,
		D3DFORMAT	d3dFormat
	)

Creates an empty d 3 d format.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

iWidth	The width.
iHeight	The height.
d3dFormat	The 3d format.

Returns:

true if it succeeds, false if it fails.

bool CPicture::CreateEmptyPixelFormat	(	int	iWidth,
		int	iHeight,
		Gdiplus::PixelFormat	pixelFormat
	)

Creates an empty pixel format.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

iWidth	The width.
iHeight	The height.
pixelFormat	The pixel format.

Returns:

true if it succeeds, false if it fails.

void CPicture::Draw	(	int	x,
		int	y
	)

Draws.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.

void CPicture::Draw	(	int	x,
		int	y,
		int	width,
		int	height
	)

Draws.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

x	The x coordinate.
y	The y coordinate.
width	The width.
height	The height.

int CPicture::GetHeight

(

)

Gets the height.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The height.

SallyAPI::Core::CTexture * CPicture::GetTexture

(

)

Gets the texture.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

null if it fails, else the texture.

int CPicture::GetWidth

(

)

Gets the width.

Author:

Christian Knobloch

Date:

19.04.2010

Returns:

The width.

bool CPicture::LoadTexture	(	const std::string &	fileName,
		bool	createMipMaps = false
	)

Loads a texture.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

fileName	Filename of the file.
createMipMaps	true to create mip maps.

Returns:

true if it succeeds, false if it fails.

bool CPicture::LoadTextureOverGDI	(	const std::string &	fileName,
		int	maxWidth = -1,
		int	maxHeight = -1
	)

Loads a texture over gdi.

Author:

Christian Knobloch

Date:

05.05.2010

Parameters:

fileName	Filename of the file.
maxWidth	The max width. If -1 than use source width.
maxHeight	The max height. If -1 than use source height.

Returns:

true if it succeeds, false if it fails.

void CPicture::SetAlphaBlending

(

int

alphaBlending

)

Sets an alpha blending.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

alphaBlending

The alpha blending.

void CPicture::SetHeight

(

int

height

)

Sets a height.

Author:

Christian Knobloch

Date:

21.05.2010

Parameters:

height

The height.

void CPicture::SetRotationAngleX

(

float

angle

)

Sets a rotation angle x coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angle

The angle.

void CPicture::SetRotationAngleY

(

float

angle

)

Sets a rotation angle y coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angle

The angle.

void CPicture::SetRotationAngleZ

(

float

angle

)

Sets a rotation angle z coordinate coordinate.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

angle

The angle.

void CPicture::SetTexture

(

SallyAPI::Core::CTexture *

texture

)

Sets a texture.

Author:

Christian Knobloch

Date:

19.04.2010

Parameters:

[in,out]

texture

If non-null, the texture.

void CPicture::SetWidth

(

int

width

)

Sets a width.

Author:

Christian Knobloch

Date:

21.05.2010

Parameters:

width

The width.

void CPicture::UpdateDimensions

(

)

Updates the width and hight information.

Author:

Christian Knobloch

Date:

21.05.2010

---

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

• D:/source/c++/Programme/sally/sally/sallyAPI/Picture.h
• D:/source/c++/Programme/sally/sally/sallyAPI/Picture.cpp