Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Paradox.Graphics.ImageFragment Class Reference

A region of an image. More...

Inheritance diagram for SiliconStudio.Paradox.Graphics.ImageFragment:
SiliconStudio.Paradox.Graphics.Sprite SiliconStudio.Paradox.UI.UIImage

Public Member Functions

 ImageFragment (string fragmentName)
 Creates an empty image fragment having the provided name. More...
 
 ImageFragment (string fragmentName, Texture2D color, Texture2D alpha)
 Creates a image fragment having the provided color/alpha textures and name. The region size is initialized with the whole size of the texture. More...
 
override string ToString ()
 

Properties

string Name [get, set]
 Gets or sets the name of the image fragment. More...
 
Texture2D Texture [get, set]
 The texture in which the image is contained More...
 
Texture2D TextureAlpha [get, set]
 The texture in which the image alpha is contained More...
 
virtual bool SubstituteAlpha [get]
 Gets a value indicating if the alpha component of the ImageFragment should be taken from the color of the TextureAlpha texture or not. More...
 
virtual RectangleF Region [get, set]
 The rectangle specifying the region of the texture to use as fragment. More...
 
bool IsTransparent [get, set]
 Gets or sets the value indicating if the fragment contains transparent regions. More...
 
virtual ImageOrientation Orientation [get, set]
 Gets or sets the rotation to apply to the texture region when rendering the ImageFragment More...
 

Detailed Description

A region of an image.

Definition at line 10 of file ImageFragment.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Graphics.ImageFragment.ImageFragment ( string  fragmentName)

Creates an empty image fragment having the provided name.

Parameters
fragmentNameName of the fragment

Definition at line 23 of file ImageFragment.cs.

SiliconStudio.Paradox.Graphics.ImageFragment.ImageFragment ( string  fragmentName,
Texture2D  color,
Texture2D  alpha 
)

Creates a image fragment having the provided color/alpha textures and name. The region size is initialized with the whole size of the texture.

Parameters
fragmentNameName of the fragment
colorThe texture to use as color
alphathe texture to use as alpha

Definition at line 35 of file ImageFragment.cs.

Member Function Documentation

override string SiliconStudio.Paradox.Graphics.ImageFragment.ToString ( )

Definition at line 96 of file ImageFragment.cs.

Property Documentation

bool SiliconStudio.Paradox.Graphics.ImageFragment.IsTransparent
getset

Gets or sets the value indicating if the fragment contains transparent regions.

Definition at line 88 of file ImageFragment.cs.

string SiliconStudio.Paradox.Graphics.ImageFragment.Name
getset

Gets or sets the name of the image fragment.

Definition at line 52 of file ImageFragment.cs.

virtual ImageOrientation SiliconStudio.Paradox.Graphics.ImageFragment.Orientation
getset

Gets or sets the rotation to apply to the texture region when rendering the ImageFragment

Definition at line 94 of file ImageFragment.cs.

virtual RectangleF SiliconStudio.Paradox.Graphics.ImageFragment.Region
getset

The rectangle specifying the region of the texture to use as fragment.

Definition at line 79 of file ImageFragment.cs.

virtual bool SiliconStudio.Paradox.Graphics.ImageFragment.SubstituteAlpha
get

Gets a value indicating if the alpha component of the ImageFragment should be taken from the color of the TextureAlpha texture or not.

Definition at line 70 of file ImageFragment.cs.

Texture2D SiliconStudio.Paradox.Graphics.ImageFragment.Texture
getset

The texture in which the image is contained

Definition at line 58 of file ImageFragment.cs.

Texture2D SiliconStudio.Paradox.Graphics.ImageFragment.TextureAlpha
getset

The texture in which the image alpha is contained

Definition at line 64 of file ImageFragment.cs.


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