SiliconStudio.TextureConverter.TexImage Class Reference

Temporary format containing texture data and information. Used as buffer between texture libraries. More...

Inheritance diagram for SiliconStudio.TextureConverter.TexImage:

Classes
struct	SubImage
	A structure describing an image of one mip map level (of one member in an array texture). More...

Public Types
enum	TextureDimension { TextureDimension.Texture1D, TextureDimension.Texture2D, TextureDimension.Texture3D, TextureDimension.TextureCube }
	The Different types of texture More...

Public Member Functions
	TexImage (IntPtr data, int dataSize, int width, int height, int depth, SiliconStudio.Paradox.Graphics.PixelFormat format, int mipmapCount, int arraySize, TextureDimension dimension, int faceCount=1)
	Initializes a new instance of the TexImage class. More...
override bool	Equals (object obj)
override int	GetHashCode ()
Object	Clone ()
	Creates a new object that is a copy of the current instance. More...
virtual Object	Clone (bool CopyMemory)
	Creates a new object that is a copy of the current instance. More...
void	Update ()
	Forces the last current library to update the image data. More...
void	Dispose ()
	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
override string	ToString ()

Properties
IntPtr	Data [get, set]
int	DataSize [get, set]
int	Width [get, set]
int	Height [get, set]
int	Depth [get, set]
int	RowPitch [get, set]
int	SlicePitch [get, set]
SiliconStudio.Paradox.Graphics.PixelFormat	Format [get, set]
int	ArraySize [get, set]
int	MipmapCount [get, set]
SubImage[]	SubImageArray [get, set]
TextureDimension	Dimension [get, set]
string	Name [get, set]
int	FaceCount [get, set]

Detailed Description

Temporary format containing texture data and information. Used as buffer between texture libraries.

Definition at line 13 of file TexImage.cs.

Member Enumeration Documentation

enum SiliconStudio.TextureConverter.TexImage.TextureDimension

The Different types of texture

Enumerator
Texture1D
Texture2D
Texture3D
TextureCube

Definition at line 46 of file TexImage.cs.

Constructor & Destructor Documentation

SiliconStudio.TextureConverter.TexImage.TexImage	(	IntPtr	data,
		int	dataSize,
		int	width,
		int	height,
		int	depth,
		SiliconStudio.Paradox.Graphics.PixelFormat	format,
		int	mipmapCount,
		int	arraySize,
		TextureDimension	dimension,
		int	faceCount = 1
	)

Initializes a new instance of the TexImage class.

Parameters

data	The data.
dataSize	Size of the data.
width	The width.
height	The height.
depth	The depth.
format	The format.
mipmapCount	The mipmap count.
arraySize	Size of the array.
dimension	The dimension.
faceCount	The face count (multiple of 6 if Texture Cube, 1 otherwise).

Definition at line 105 of file TexImage.cs.

References DirectX.format.

Member Function Documentation

Object SiliconStudio.TextureConverter.TexImage.Clone

(

)

Creates a new object that is a copy of the current instance.

This is a deep copy.

Returns

A new object that is a copy of this instance.

Definition at line 228 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TextureTool.CreateImageFromAlphaComponent(), and SiliconStudio.TextureConverter.TextureTool.Save().

virtual Object SiliconStudio.TextureConverter.TexImage.Clone ( bool  CopyMemory )

virtual

Creates a new object that is a copy of the current instance.

Parameters

CopyMemory

if set to true [copy memory], it is a DEEP copy.

Returns

A new object that is a copy of this instance.

Reimplemented in SiliconStudio.TextureConverter.TexAtlas.

Definition at line 241 of file TexImage.cs.

References SiliconStudio.TextureConverter.TexImage.Data.

void SiliconStudio.TextureConverter.TexImage.Dispose

(

)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Definition at line 341 of file TexImage.cs.

override bool SiliconStudio.TextureConverter.TexImage.Equals

(

object

obj

)

Definition at line 178 of file TexImage.cs.

References SiliconStudio.TextureConverter.TexImage.SubImage.DataSize, SiliconStudio.TextureConverter.TexImage.SubImage.Height, SiliconStudio.TextureConverter.TexImage.SubImage.RowPitch, SiliconStudio.TextureConverter.TexImage.SubImage.SlicePitch, SiliconStudio.TextureConverter.TexImage.SubImageArray, and SiliconStudio.TextureConverter.TexImage.SubImage.Width.

override int SiliconStudio.TextureConverter.TexImage.GetHashCode

(

)

Definition at line 210 of file TexImage.cs.

override string SiliconStudio.TextureConverter.TexImage.ToString

(

)

Definition at line 350 of file TexImage.cs.

void SiliconStudio.TextureConverter.TexImage.Update

(

)

Forces the last current library to update the image data.

Definition at line 300 of file TexImage.cs.

Property Documentation

int SiliconStudio.TextureConverter.TexImage.ArraySize

getset

Definition at line 26 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TextureTool.CreateImageFromRegion(), SiliconStudio.TextureConverter.TextureTool.Extract(), SiliconStudio.TextureConverter.TextureTool.Insert(), SiliconStudio.TextureConverter.TextureTool.Remove(), and SiliconStudio.TextureConverter.TextureTool.Update().

IntPtr SiliconStudio.TextureConverter.TexImage.Data

getset

Definition at line 16 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TexImage.Clone().

int SiliconStudio.TextureConverter.TexImage.DataSize

getset

Definition at line 17 of file TexImage.cs.

int SiliconStudio.TextureConverter.TexImage.Depth

getset

Definition at line 20 of file TexImage.cs.

TextureDimension SiliconStudio.TextureConverter.TexImage.Dimension

getset

Definition at line 29 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TextureTool.CreateImageFromRegion().

int SiliconStudio.TextureConverter.TexImage.FaceCount

getset

Definition at line 33 of file TexImage.cs.

SiliconStudio.Paradox.Graphics.PixelFormat SiliconStudio.TextureConverter.TexImage.Format

getset

Definition at line 23 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TextureTool.ColorKey(), SiliconStudio.TextureConverter.TextureTool.Compress(), SiliconStudio.TextureConverter.TextureTool.CorrectGamma(), SiliconStudio.TextureConverter.TextureTool.CreateAtlas(), SiliconStudio.TextureConverter.TextureTool.CreateImageFromRegion(), SiliconStudio.TextureConverter.TextureTool.Decompress(), SiliconStudio.TextureConverter.TextureTool.Extract(), SiliconStudio.TextureConverter.TextureTool.ExtractAll(), SiliconStudio.TextureConverter.TextureTool.Flip(), SiliconStudio.TextureConverter.TextureTool.FlipSub(), SiliconStudio.TextureConverter.TextureTool.GenerateMipMaps(), SiliconStudio.TextureConverter.TextureTool.GenerateNormalMap(), SiliconStudio.TextureConverter.TextureTool.PreMultiplyAlpha(), SiliconStudio.TextureConverter.TextureTool.Rescale(), SiliconStudio.TextureConverter.TextureTool.Resize(), SiliconStudio.TextureConverter.TextureTool.Save(), and SiliconStudio.TextureConverter.TextureTool.SwitchChannel().

int SiliconStudio.TextureConverter.TexImage.Height

getset

Definition at line 19 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TextureTool.Resize().

int SiliconStudio.TextureConverter.TexImage.MipmapCount

getset

Definition at line 27 of file TexImage.cs.

string SiliconStudio.TextureConverter.TexImage.Name

getset

Definition at line 30 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TextureTool.Update().

int SiliconStudio.TextureConverter.TexImage.RowPitch

getset

Definition at line 21 of file TexImage.cs.

int SiliconStudio.TextureConverter.TexImage.SlicePitch

getset

Definition at line 22 of file TexImage.cs.

SubImage [] SiliconStudio.TextureConverter.TexImage.SubImageArray

getset

Definition at line 28 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TexImage.Equals().

int SiliconStudio.TextureConverter.TexImage.Width

getset

Definition at line 18 of file TexImage.cs.

Referenced by SiliconStudio.TextureConverter.TextureTool.Resize().

---

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

• D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/tools/SiliconStudio.TextureConverter/Frontend/TexImage.cs