OgreGenUtilites.h File Reference

#include <Ogre.h>
#include "installer/common/Logger.h"
#include "installer/common/Vram.h"

Include dependency graph for OgreGenUtilites.h:

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

Go to the source code of this file.

Classes
struct	MeshData
	Mesh data. More...
struct	TexForGen
	Texture data. More...

Typedefs
typedef std::vector< TexForGen >	VectorTexForGen

Enumerations
enum	BPP { BPP_4 = 0 , BPP_8 = 1 , BPP_BLACK = -1 }
	Bits per pixel modes. More...

Functions
void	CreateTexture (Vram *vram, const MeshData &mesh_data, const Ogre::String &texture_file_name, const VectorTexForGen &textures)
	Creates a texture from video memory and saves it to a file. More...
void	CreateMaterial (const Ogre::String &material_name, const Ogre::String &material_file_name, const Ogre::String &texture_name, const Ogre::String &vertex_program, const Ogre::String &fragment_program)
	Creates a material and saves it to a file. More...
void	CreateTextureFromVram (const Ogre::PixelBox &pixel_box, Vram *vram, const int start_x, const int start_y, const int clut_x, const int clut_y, const int texture_x, const int texture_y, const BPP bpp, const bool transparency)
	Creates a material from video memory and adds it to the texture list. More...
void	AddTexture (TexForGen &texture, const MeshData &data, VectorTexForGen &textures, Logger *logger)
	Adds a texture to the list. More...
void	AddTransparency (u32 &colour, const bool transparency, const bool stp)
	Adds or removes a transparency to a colour. More...

Typedef Documentation

VectorTexForGen

typedef std::vector< TexForGen > VectorTexForGen

Enumeration Type Documentation

BPP

enum BPP

Bits per pixel modes.

Enumerator
BPP_4	4 bites per pixel.
BPP_8	8 bits per pixel.
BPP_BLACK	No color data, always black.

Function Documentation

AddTexture()

void AddTexture	(	TexForGen &	texture,
		const MeshData &	data,
		VectorTexForGen &	textures,
		Logger *	logger
	)

Adds a texture to the list.

Parameters

[in]	texture	Texture information.
[in]	data	Mesh information.
[in,out]	textures	The texture will be added to this list.
[in]	logger	Custom logger to print info about the process. It can be NULL, but then nothing will be printed.

AddTransparency()

void AddTransparency	(	u32 &	colour,
		const bool	transparency,
		const bool	stp
	)

Adds or removes a transparency to a colour.

Parameters

[in,out]	colour	The colour to add or remove the transparency to.
[in]	transparency	True to add transparency, false to remove it.
[in]	stp

Todo:

Understand and document.

CreateMaterial()

void CreateMaterial	(	const Ogre::String &	material_name,
		const Ogre::String &	material_file_name,
		const Ogre::String &	texture_name,
		const Ogre::String &	vertex_program,
		const Ogre::String &	fragment_program
	)

Creates a material and saves it to a file.

Parameters

[in]	material_name	The material name.
[in]	material_file_name	Path to the material file to save.
[in]	texture_name	Name of the texture to assign to the material.
[in]	vertex_program

Todo:

Understand and document. Can be empty.

Parameters

[in]

fragment_program

Todo:

Understand and document. Can be empty.

CreateTexture()

void CreateTexture	(	Vram *	vram,
		const MeshData &	mesh_data,
		const Ogre::String &	texture_file_name,
		const VectorTexForGen &	textures
	)

Creates a texture from video memory and saves it to a file.

Parameters

[in]	vram	Memory block to load the texture from.
[in]	mesh_data	Information about the mesh the texture is assigned to.
[in]	texture_file_name	Path to the texture file to save.
[in]	textures

Todo:

It's used to get some coordinates, but for what?

CreateTextureFromVram()

void CreateTextureFromVram	(	const Ogre::PixelBox &	pixel_box,
		Vram *	vram,
		const int	start_x,
		const int	start_y,
		const int	clut_x,
		const int	clut_y,
		const int	texture_x,
		const int	texture_y,
		const BPP	bpp,
		const bool	transparency
	)

Creates a material from video memory and adds it to the texture list.

Parameters

[in]	pixel_box	Texture image descriptor.
[in]	vram	Memory block to load the material from.
[in]	start_x	X coordinate for the texture.
[in]	start_y	Y coordinate for the texture.
[in]	clut_x	X coordinate for the texture CLUT.
[in]	clut_y	Y coordinate for the texture CLUT.
[in]	texture_x	X coordinate for the texture.
[in]	texture_y	Y coordinate for the texture.
[in]	bpp	BPP mode for the texture colour.
[in]	transparency	Indicates if the texture has transparencies.

Todo:

What's the difference between start_x/start_y and texture_x/texture_y?