Surface.h File Reference

#include <Ogre.h>

Include dependency graph for Surface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	Surface
	A surface description. More...

Functions
Surface *	CreateSurface (const int width, const int height)
	Creates an empty surface. More...
void	CopyToSurface (Surface *dest, const int x_d, const int y_d, Surface *src)
	Copies one surface into another. More...
Surface *	CreateSubSurface (const int x, const int y, const int width, const int height, Surface *surface)
	Creates a partial surface from a surface. More...
Surface *	CreateSurfaceFrom (const int width, const int height, unsigned char *pixels)
	Creates a surface from a list of pixels. More...

Function Documentation

CopyToSurface()

void CopyToSurface	(	Surface *	dest,
		const int	x_d,
		const int	y_d,
		Surface *	src
	)

Copies one surface into another.

It can copy just sections of surfaces, but always from the top left corner.

Parameters

[out]	dest	The target surface.
[in]	x_d	Number of columns to copy.
[in]	y_d	Number of rows to copy.
[in]	src	The source surface.

CreateSubSurface()

Surface * CreateSubSurface	(	const int	x,
		const int	y,
		const int	width,
		const int	height,
		Surface *	surface
	)

Creates a partial surface from a surface.

Parameters

[in]	x	Starting column to copy from the original surface.
[in]	y	Starting row to copy from the original surface.
[in]	width	Number of columns to copy.
[in]	height	Number of rows to copy.
[in]	surface	The original surface.

Returns

the resulting subsurface.

CreateSurface()

Surface * CreateSurface	(	const int	width,
		const int	height
	)

Creates an empty surface.

Parameters

[in]	width	The width for the new surface.
[in]	height	The height for the new surface.

CreateSurfaceFrom()

Surface * CreateSurfaceFrom	(	const int	width,
		const int	height,
		unsigned char *	pixels
	)

Creates a surface from a list of pixels.

Parameters

[in]	width	The width of the surface.
[in]	height	The height of the surface.
[in]	pixels	The list of pixels for the new surface. If there are not enough pixels to cover the entire surface, the rest of pixels will be NULL.

Returns

The new surface.