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

A Common description for all textures. More...

Inheritance diagram for SiliconStudio.Paradox.Graphics.TextureDescription:
IEquatable< TextureDescription >

Public Member Functions

TextureDescription ToStagingDescription ()
 Gets the staging description for this instance.. More...
 
bool Equals (TextureDescription other)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static implicit operator TextureDescription (ImageDescription description)
 Performs an explicit conversion from ImageDescription to TextureDescription. More...
 
static implicit operator ImageDescription (TextureDescription description)
 Performs an explicit conversion from ImageDescription to TextureDescription. More...
 
static bool operator== (TextureDescription left, TextureDescription right)
 Implements the operator ==. More...
 
static bool operator!= (TextureDescription left, TextureDescription right)
 Implements the operator !=. More...
 

Public Attributes

TextureDimension Dimension
 The dimension of a texture. More...
 
int Width
 
int Height
 
int Depth
 
int ArraySize
 
int MipLevels
 
PixelFormat Format
 
MSAALevel Level
 
GraphicsResourceUsage Usage
 
TextureFlags Flags
 

Detailed Description

A Common description for all textures.

Definition at line 33 of file TextureDescription.cs.

Member Function Documentation

bool SiliconStudio.Paradox.Graphics.TextureDescription.Equals ( TextureDescription  other)

Definition at line 155 of file TextureDescription.cs.

override bool SiliconStudio.Paradox.Graphics.TextureDescription.Equals ( object  obj)

Definition at line 160 of file TextureDescription.cs.

override int SiliconStudio.Paradox.Graphics.TextureDescription.GetHashCode ( )

Definition at line 167 of file TextureDescription.cs.

static implicit SiliconStudio.Paradox.Graphics.TextureDescription.operator ImageDescription ( TextureDescription  description)
static

Performs an explicit conversion from ImageDescription to TextureDescription.

Parameters
descriptionThe image description.
Returns
The result of the conversion.

Definition at line 141 of file TextureDescription.cs.

static implicit SiliconStudio.Paradox.Graphics.TextureDescription.operator TextureDescription ( ImageDescription  description)
static

Performs an explicit conversion from ImageDescription to TextureDescription.

Parameters
descriptionThe image description.
Returns
The result of the conversion.

Definition at line 120 of file TextureDescription.cs.

static bool SiliconStudio.Paradox.Graphics.TextureDescription.operator!= ( TextureDescription  left,
TextureDescription  right 
)
static

Implements the operator !=.

Parameters
leftThe left.
rightThe right.
Returns
The result of the operator.

Definition at line 202 of file TextureDescription.cs.

static bool SiliconStudio.Paradox.Graphics.TextureDescription.operator== ( TextureDescription  left,
TextureDescription  right 
)
static

Implements the operator ==.

Parameters
leftThe left.
rightThe right.
Returns
The result of the operator.

Definition at line 191 of file TextureDescription.cs.

TextureDescription SiliconStudio.Paradox.Graphics.TextureDescription.ToStagingDescription ( )

Gets the staging description for this instance..

Returns
A Staging description

Definition at line 107 of file TextureDescription.cs.

Member Data Documentation

int SiliconStudio.Paradox.Graphics.TextureDescription.ArraySize

Number of textures in the array. The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture1DArraySize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

This field is only valid for Texture1D, Texture2D and TextureCube

This field is only valid for textures: Texture1D, Texture2D and TextureCube.

Definition at line 73 of file TextureDescription.cs.

int SiliconStudio.Paradox.Graphics.TextureDescription.Depth

Texture depth (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture3DSize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

This field is only valid for Texture3D.

Definition at line 62 of file TextureDescription.cs.

TextureDimension SiliconStudio.Paradox.Graphics.TextureDescription.Dimension

The dimension of a texture.

Definition at line 38 of file TextureDescription.cs.

Referenced by SiliconStudio.Paradox.Graphics.Texture.New().

TextureFlags SiliconStudio.Paradox.Graphics.TextureDescription.Flags

Flags (see SharpDX.Direct3D11.BindFlags) for binding to pipeline stages. The flags can be combined by a logical OR. For a 1D texture, the allowable values are: SharpDX.Direct3D11.BindFlags.ShaderResource, SharpDX.Direct3D11.BindFlags.RenderTarget and SharpDX.Direct3D11.BindFlags.DepthStencil.

Definition at line 101 of file TextureDescription.cs.

PixelFormat SiliconStudio.Paradox.Graphics.TextureDescription.Format

Texture format (see SharpDX.DXGI.Format).

Definition at line 83 of file TextureDescription.cs.

int SiliconStudio.Paradox.Graphics.TextureDescription.Height

Texture height (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture3DSize (2048). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

This field is only valid for Texture2D, Texture3D and TextureCube.

Definition at line 54 of file TextureDescription.cs.

Referenced by SiliconStudio.Paradox.Effects.AOPlugin.Load().

MSAALevel SiliconStudio.Paradox.Graphics.TextureDescription.Level

Structure that specifies multisampling parameters for the texture. See SharpDX.DXGI.SampleDescription.

This field is only valid for Texture2D.

Definition at line 91 of file TextureDescription.cs.

int SiliconStudio.Paradox.Graphics.TextureDescription.MipLevels

The maximum number of mipmap levels in the texture. See the remarks in SharpDX.Direct3D11.ShaderResourceViewDescription.Texture1DResource. Use 1 for a multisampled texture; or 0 to generate a full set of subtextures.

Definition at line 78 of file TextureDescription.cs.

GraphicsResourceUsage SiliconStudio.Paradox.Graphics.TextureDescription.Usage

Value that identifies how the texture is to be read from and written to. The most common value is SharpDX.Direct3D11.ResourceUsage.Default; see SharpDX.Direct3D11.ResourceUsage for all possible values.

Definition at line 96 of file TextureDescription.cs.

Referenced by SiliconStudio.Paradox.Graphics.Texture.GetDataAsImage().

int SiliconStudio.Paradox.Graphics.TextureDescription.Width

Texture width (in texels). The range is from 1 to SharpDX.Direct3D11.Resource.MaximumTexture1DSize (16384). However, the range is actually constrained by the feature level at which you create the rendering device. For more information about restrictions, see Remarks.

This field is valid for all textures: Texture1D, Texture2D, Texture3D and TextureCube.

Definition at line 46 of file TextureDescription.cs.


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