AtomicNET : AtomicEngine Namespace

Texture Class

Base class for texture resources.

Syntax

public class Texture : Resource

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from Resource.

Public Constructors

Documentation for this section has not yet been entered.
Construct.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

Anisotropy uint . Documentation for this section has not yet been entered.
AsyncLoadState AsyncLoadState . Documentation for this section has not yet been entered. (Inherited from Resource.)
BackupTexture Texture . Documentation for this section has not yet been entered.
BorderColor Color . Documentation for this section has not yet been entered.
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Components uint . Documentation for this section has not yet been entered.
[read-only]
Compressed bool . Documentation for this section has not yet been entered.
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Depth int . Documentation for this section has not yet been entered.
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
FilterMode TextureFilterMode . Documentation for this section has not yet been entered.
[read-only]
Format uint . Documentation for this section has not yet been entered.
[read-only]
Height int . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Levels uint . Documentation for this section has not yet been entered.
MemoryUse uint . Documentation for this section has not yet been entered. (Inherited from Resource.)
Name string . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NameHash StringHash . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[write-only]
NumLevels uint . Documentation for this section has not yet been entered.
[write-only]
Parameters XMLFile . Documentation for this section has not yet been entered.
[read-only]
ParametersDirty bool . Documentation for this section has not yet been entered.
ShadowCompare bool . Documentation for this section has not yet been entered.
SRGB bool . Documentation for this section has not yet been entered.
[read-only]
Target uint . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Usage TextureUsage . Documentation for this section has not yet been entered.
[read-only]
UseTimer uint . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
Width int . Documentation for this section has not yet been entered.

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful. (Inherited from Resource.)
static
CheckMaxLevels (int, int, uint) : uint
Check maximum allowed mip levels for a specific texture size.
static
CheckMaxLevels (int, int, int, uint) : uint
Check maximum allowed mip levels for a specific 3D texture size.
static
csb_Atomic_Texture_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
EndLoad () : bool
Finish resource loading. Always called from the main thread. Return true if successful. (Inherited from Resource.)
GetAddressMode (TextureCoordinate) : TextureAddressMode
Return addressing mode by texture coordinate.
GetAnisotropy () : uint
Return texture max. anisotropy level. Value 0 means to use the default value from Renderer.
GetAsyncLoadState () : AsyncLoadState
Return the asynchronous loading state. (Inherited from Resource.)
GetBackupTexture () : Texture
Return backup texture.
GetBorderColor () : Color
Return border color.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetComponents () : uint
Return number of image components required to receive pixel data from GetData(), or 0 for compressed images.
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetDataSize (int, int) : uint
Return data size in bytes for a rectangular region.
GetDataSize (int, int, int) : uint
Return data size in bytes for a volume region.
static
GetDataType (uint) : uint
Return the data type corresponding to an OpenGL internal format.
GetDepth () : int
Return height.
static
GetDSVFormat (uint) : uint
Return the depth-stencil view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
static
GetExternalFormat (uint) : uint
Return the non-internal texture format corresponding to an OpenGL internal format.
GetFilterMode () : TextureFilterMode
Return filtering mode.
GetFormat () : uint
Return API-specific texture format.
GetHeight () : int
Return height.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetLevelDepth (uint) : int
Return mip level depth, or 0 if level does not exist.
GetLevelHeight (uint) : int
Return mip level width, or 0 if level does not exist.
GetLevels () : uint
Return number of mip levels.
GetLevelWidth (uint) : int
Return mip level width, or 0 if level does not exist.
GetMemoryUse () : uint
Return memory use in bytes, possibly approximate. (Inherited from Resource.)
GetMipsToSkip (int) : int
Return mip levels to skip on a quality setting when loading.
GetName () : string
Return name. (Inherited from Resource.)
GetNameHash () : StringHash
Return name hash. (Inherited from Resource.)
GetParametersDirty () : bool
Return whether the parameters are dirty.
GetRowDataSize (int) : uint
Return data size in bytes for a pixel or block row.
GetShadowCompare () : bool
Return whether shadow compare is enabled. Not used on Direct3D9.
GetSRGB () : bool
Return whether is using sRGB sampling and writing.
GetSRGBFormat (uint) : uint
Convert format to sRGB. Not used on Direct3D9.
static
GetSRVFormat (uint) : uint
Return the shader resource view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTarget () : uint
Return texture's target. Only used on OpenGL.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetUsage () : TextureUsage
Return texture usage type.
GetUseTimer () : uint
Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero. (Inherited from Resource.)
GetWidth () : int
Return width.
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsCompressed () : bool
Return whether the texture format is compressed.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
Load (Deserializer) : bool
Documentation for this section has not yet been entered. (Inherited from Resource.)
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
ResetUseTimer ()
Reset last used timer. (Inherited from Resource.)
Save (Serializer) : bool
Save resource. Return true if successful. (Inherited from Resource.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAddressMode (TextureCoordinate, TextureAddressMode)
Set addressing mode by texture coordinate.
SetAnisotropy (uint)
Set texture max. anisotropy level. No effect if not using anisotropic filtering. Value 0 (default) uses the default setting from Renderer.
SetAsyncLoadState (AsyncLoadState)
Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user. (Inherited from Resource.)
SetBackupTexture (Texture)
Set backup texture to use when rendering to this texture.
SetBorderColor (Color)
Set border color for border addressing mode.
SetFilterMode (TextureFilterMode)
Set filtering mode.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetMemoryUse (uint)
Set memory use in bytes, possibly approximate. (Inherited from Resource.)
SetMipsToSkip (int, int)
Set mip levels to skip on a quality setting when loading. Ensures higher quality levels do not skip more.
SetName (string)
Set name. (Inherited from Resource.)
SetNumLevels (uint)
Set number of requested mip levels. Needs to be called before setting size.
SetParameters (XMLFile)
Set additional parameters from an XML file.
SetParametersDirty ()
Mark parameters dirty. Called by Graphics.
SetShadowCompare (bool)
Set shadow compare mode. Not used on Direct3D9.
SetSRGB (bool)
Set sRGB sampling and writing mode.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
UpdateParameters ()
Update dirty parameters to the texture object. Called by Graphics when assigning the texture.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Texture Constructor

Documentation for this section has not yet been entered.

Syntax

public Texture ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Texture Constructor

Construct.

Syntax

public Texture (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Anisotropy Property

Documentation for this section has not yet been entered.

Syntax

public uint Anisotropy { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BackupTexture Property

Documentation for this section has not yet been entered.

Syntax

public Texture BackupTexture { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

BorderColor Property

Documentation for this section has not yet been entered.

Syntax

public Color BorderColor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

CheckMaxLevels Method

Check maximum allowed mip levels for a specific texture size.

Syntax

public static uint CheckMaxLevels (int width, int height, uint requestedLevels)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.
requestedLevels
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

CheckMaxLevels Method

Check maximum allowed mip levels for a specific 3D texture size.

Syntax

public static uint CheckMaxLevels (int width, int height, int depth, uint requestedLevels)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.
depth
Documentation for this section has not yet been entered.
requestedLevels
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Components Property

Documentation for this section has not yet been entered.

Syntax

public uint Components { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Compressed Property

Documentation for this section has not yet been entered.

Syntax

public bool Compressed { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_Texture_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_Texture_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Depth Property

Documentation for this section has not yet been entered.

Syntax

public int Depth { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

FilterMode Property

Documentation for this section has not yet been entered.

Syntax

public TextureFilterMode FilterMode { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Format Property

Documentation for this section has not yet been entered.

Syntax

public uint Format { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAddressMode Method

Return addressing mode by texture coordinate.

Syntax

public TextureAddressMode GetAddressMode (TextureCoordinate coord)

Parameters

coord
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAnisotropy Method

Return texture max. anisotropy level. Value 0 means to use the default value from Renderer.

Syntax

public uint GetAnisotropy ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetBackupTexture Method

Return backup texture.

Syntax

public Texture GetBackupTexture ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetBorderColor Method

Return border color.

Syntax

public Color GetBorderColor ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetComponents Method

Return number of image components required to receive pixel data from GetData(), or 0 for compressed images.

Syntax

public uint GetComponents ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDataSize Method

Return data size in bytes for a rectangular region.

Syntax

public uint GetDataSize (int width, int height)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDataSize Method

Return data size in bytes for a volume region.

Syntax

public uint GetDataSize (int width, int height, int depth)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.
depth
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDataType Method

Return the data type corresponding to an OpenGL internal format.

Syntax

public static uint GetDataType (uint format)

Parameters

format
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDepth Method

Return height.

Syntax

public int GetDepth ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetDSVFormat Method

Return the depth-stencil view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.

Syntax

public static uint GetDSVFormat (uint format)

Parameters

format
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetExternalFormat Method

Return the non-internal texture format corresponding to an OpenGL internal format.

Syntax

public static uint GetExternalFormat (uint format)

Parameters

format
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFilterMode Method

Return filtering mode.

Syntax

public TextureFilterMode GetFilterMode ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFormat Method

Return API-specific texture format.

Syntax

public uint GetFormat ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetHeight Method

Return height.

Syntax

public int GetHeight ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLevelDepth Method

Return mip level depth, or 0 if level does not exist.

Syntax

public int GetLevelDepth (uint level)

Parameters

level
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLevelHeight Method

Return mip level width, or 0 if level does not exist.

Syntax

public int GetLevelHeight (uint level)

Parameters

level
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLevels Method

Return number of mip levels.

Syntax

public uint GetLevels ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLevelWidth Method

Return mip level width, or 0 if level does not exist.

Syntax

public int GetLevelWidth (uint level)

Parameters

level
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetMipsToSkip Method

Return mip levels to skip on a quality setting when loading.

Syntax

public int GetMipsToSkip (int quality)

Parameters

quality
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetParametersDirty Method

Return whether the parameters are dirty.

Syntax

public bool GetParametersDirty ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetRowDataSize Method

Return data size in bytes for a pixel or block row.

Syntax

public uint GetRowDataSize (int width)

Parameters

width
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetShadowCompare Method

Return whether shadow compare is enabled. Not used on Direct3D9.

Syntax

public bool GetShadowCompare ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSRGB Method

Return whether is using sRGB sampling and writing.

Syntax

public bool GetSRGB ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSRGBFormat Method

Convert format to sRGB. Not used on Direct3D9.

Syntax

public uint GetSRGBFormat (uint format)

Parameters

format
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSRVFormat Method

Return the shader resource view format corresponding to a texture format. Handles conversion of typeless depth texture formats. Only used on Direct3D11.

Syntax

public static uint GetSRVFormat (uint format)

Parameters

format
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTarget Method

Return texture's target. Only used on OpenGL.

Syntax

public uint GetTarget ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetUsage Method

Return texture usage type.

Syntax

public TextureUsage GetUsage ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetWidth Method

Return width.

Syntax

public int GetWidth ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Height Property

Documentation for this section has not yet been entered.

Syntax

public int Height { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsCompressed Method

Return whether the texture format is compressed.

Syntax

public bool IsCompressed ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Levels Property

Documentation for this section has not yet been entered.

Syntax

public uint Levels { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

NumLevels Property

Documentation for this section has not yet been entered.

Syntax

public uint NumLevels { set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Parameters Property

Documentation for this section has not yet been entered.

Syntax

public XMLFile Parameters { set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ParametersDirty Property

Documentation for this section has not yet been entered.

Syntax

public bool ParametersDirty { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetAddressMode Method

Set addressing mode by texture coordinate.

Syntax

public void SetAddressMode (TextureCoordinate coord, TextureAddressMode address)

Parameters

coord
Documentation for this section has not yet been entered.
address
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetAnisotropy Method

Set texture max. anisotropy level. No effect if not using anisotropic filtering. Value 0 (default) uses the default setting from Renderer.

Syntax

public void SetAnisotropy (uint level)

Parameters

level
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetBackupTexture Method

Set backup texture to use when rendering to this texture.

Syntax

public void SetBackupTexture (Texture texture)

Parameters

texture
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetBorderColor Method

Set border color for border addressing mode.

Syntax

public void SetBorderColor (Color color)

Parameters

color
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetFilterMode Method

Set filtering mode.

Syntax

public void SetFilterMode (TextureFilterMode filter)

Parameters

filter
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetMipsToSkip Method

Set mip levels to skip on a quality setting when loading. Ensures higher quality levels do not skip more.

Syntax

public void SetMipsToSkip (int quality, int toSkip)

Parameters

quality
Documentation for this section has not yet been entered.
toSkip
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetNumLevels Method

Set number of requested mip levels. Needs to be called before setting size.

Syntax

public void SetNumLevels (uint levels)

Parameters

levels
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetParameters Method

Set additional parameters from an XML file.

Syntax

public void SetParameters (XMLFile xml)

Parameters

xml
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetParametersDirty Method

Mark parameters dirty. Called by Graphics.

Syntax

public void SetParametersDirty ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetShadowCompare Method

Set shadow compare mode. Not used on Direct3D9.

Syntax

public void SetShadowCompare (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetSRGB Method

Set sRGB sampling and writing mode.

Syntax

public void SetSRGB (bool enable)

Parameters

enable
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ShadowCompare Property

Documentation for this section has not yet been entered.

Syntax

public bool ShadowCompare { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SRGB Property

Documentation for this section has not yet been entered.

Syntax

public bool SRGB { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Target Property

Documentation for this section has not yet been entered.

Syntax

public uint Target { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

UpdateParameters Method

Update dirty parameters to the texture object. Called by Graphics when assigning the texture.

Syntax

public void UpdateParameters ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Usage Property

Documentation for this section has not yet been entered.

Syntax

public TextureUsage Usage { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Width Property

Documentation for this section has not yet been entered.

Syntax

public int Width { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0