AtomicNET : AtomicEngine Namespace

Texture2D Class

2D texture resource.

Syntax

public class Texture2D : 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

Members

See Also: Inherited members from Texture.

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. (Inherited from Texture.)
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. (Inherited from Texture.)
BorderColor Color . Documentation for this section has not yet been entered. (Inherited from Texture.)
[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. (Inherited from Texture.)
[read-only]
Compressed bool . Documentation for this section has not yet been entered. (Inherited from Texture.)
[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. (Inherited from Texture.)
[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. (Inherited from Texture.)
[read-only]
Format uint . Documentation for this section has not yet been entered. (Inherited from Texture.)
[read-only]
Height int . Documentation for this section has not yet been entered. (Inherited from Texture.)
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. (Inherited from Texture.)
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. (Inherited from Texture.)
[write-only]
Parameters XMLFile . Documentation for this section has not yet been entered. (Inherited from Texture.)
[read-only]
ParametersDirty bool . Documentation for this section has not yet been entered. (Inherited from Texture.)
[read-only]
RenderSurface RenderSurface . Documentation for this section has not yet been entered.
ShadowCompare bool . Documentation for this section has not yet been entered. (Inherited from Texture.)
SRGB bool . Documentation for this section has not yet been entered. (Inherited from Texture.)
[read-only]
Target uint . Documentation for this section has not yet been entered. (Inherited from Texture.)
[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. (Inherited from Texture.)
[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. (Inherited from Texture.)

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.)
override
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful.
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful. (Inherited from Resource.)
static
csb_Atomic_Texture2D_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
override
EndLoad () : bool
Finish resource loading. Always called from the main thread. Return true if successful.
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. (Inherited from Texture.)
GetAnisotropy () : uint
Return texture max. anisotropy level. Value 0 means to use the default value from Renderer. (Inherited from Texture.)
GetAsyncLoadState () : AsyncLoadState
Return the asynchronous loading state. (Inherited from Resource.)
GetBackupTexture () : Texture
Return backup texture. (Inherited from Texture.)
GetBorderColor () : Color
Return border color. (Inherited from Texture.)
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. (Inherited from Texture.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetDataSize (int, int) : uint
Return data size in bytes for a rectangular region. (Inherited from Texture.)
GetDataSize (int, int, int) : uint
Return data size in bytes for a volume region. (Inherited from Texture.)
GetDepth () : int
Return height. (Inherited from Texture.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFilterMode () : TextureFilterMode
Return filtering mode. (Inherited from Texture.)
GetFormat () : uint
Return API-specific texture format. (Inherited from Texture.)
GetHeight () : int
Return height. (Inherited from Texture.)
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. (Inherited from Texture.)
GetLevelHeight (uint) : int
Return mip level width, or 0 if level does not exist. (Inherited from Texture.)
GetLevels () : uint
Return number of mip levels. (Inherited from Texture.)
GetLevelWidth (uint) : int
Return mip level width, or 0 if level does not exist. (Inherited from Texture.)
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. (Inherited from Texture.)
GetName () : string
Return name. (Inherited from Resource.)
GetNameHash () : StringHash
Return name hash. (Inherited from Resource.)
GetParametersDirty () : bool
Return whether the parameters are dirty. (Inherited from Texture.)
GetRenderSurface () : RenderSurface
Return render surface.
GetRowDataSize (int) : uint
Return data size in bytes for a pixel or block row. (Inherited from Texture.)
GetShadowCompare () : bool
Return whether shadow compare is enabled. Not used on Direct3D9. (Inherited from Texture.)
GetSRGB () : bool
Return whether is using sRGB sampling and writing. (Inherited from Texture.)
GetSRGBFormat (uint) : uint
Convert format to sRGB. Not used on Direct3D9. (Inherited from Texture.)
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTarget () : uint
Return texture's target. Only used on OpenGL. (Inherited from Texture.)
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. (Inherited from Texture.)
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. (Inherited from Texture.)
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. (Inherited from Texture.)
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.)
OnDeviceLost ()
Mark the GPU resource destroyed on context destruction.
OnDeviceReset ()
Recreate the GPU resource and restore data if applicable.
Refs () : int
Return reference count. (Inherited from RefCounted.)
Release ()
Release the texture.
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. (Inherited from Texture.)
SetAnisotropy (uint)
Set texture max. anisotropy level. No effect if not using anisotropic filtering. Value 0 (default) uses the default setting from Renderer. (Inherited from Texture.)
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. (Inherited from Texture.)
SetBorderColor (Color)
Set border color for border addressing mode. (Inherited from Texture.)
SetData (Image, bool) : bool
Set data from an image. Return true if successful. Optionally make a single channel image alpha-only.
SetFilterMode (TextureFilterMode)
Set filtering mode. (Inherited from Texture.)
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. (Inherited from Texture.)
SetName (string)
Set name. (Inherited from Resource.)
SetNumLevels (uint)
Set number of requested mip levels. Needs to be called before setting size. (Inherited from Texture.)
SetParameters (XMLFile)
Set additional parameters from an XML file. (Inherited from Texture.)
SetParametersDirty ()
Mark parameters dirty. Called by Graphics. (Inherited from Texture.)
SetShadowCompare (bool)
Set shadow compare mode. Not used on Direct3D9. (Inherited from Texture.)
SetSize (int, int, uint, TextureUsage) : bool
Set size, format and usage. Zero size will follow application window size. Return true if successful.
SetSRGB (bool)
Set sRGB sampling and writing mode. (Inherited from Texture.)
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. (Inherited from Texture.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Texture2D Constructor

Documentation for this section has not yet been entered.

Syntax

public Texture2D ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Texture2D Constructor

Construct.

Syntax

public Texture2D (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

BeginLoad Method

Load resource from stream. May be called from a worker thread. Return true if successful.

Syntax

public override bool BeginLoad (Deserializer source)

Parameters

source
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

csb_Atomic_Texture2D_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_Texture2D_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

EndLoad Method

Finish resource loading. Always called from the main thread. Return true if successful.

Syntax

public override bool EndLoad ()

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

GetRenderSurface Method

Return render surface.

Syntax

public RenderSurface GetRenderSurface ()

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

OnDeviceLost Method

Mark the GPU resource destroyed on context destruction.

Syntax

public virtual void OnDeviceLost ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

OnDeviceReset Method

Recreate the GPU resource and restore data if applicable.

Syntax

public virtual void OnDeviceReset ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Release Method

Release the texture.

Syntax

public virtual void Release ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

RenderSurface Property

Documentation for this section has not yet been entered.

Syntax

public RenderSurface RenderSurface { 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

SetData Method

Set data from an image. Return true if successful. Optionally make a single channel image alpha-only.

Syntax

public bool SetData (Image image, bool useAlpha)

Parameters

image
Documentation for this section has not yet been entered.
useAlpha
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

SetSize Method

Set size, format and usage. Zero size will follow application window size. Return true if successful.

Syntax

public bool SetSize (int width, int height, uint format, TextureUsage usage)

Parameters

width
Documentation for this section has not yet been entered.
height
Documentation for this section has not yet been entered.
format
Documentation for this section has not yet been entered.
usage
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