AtomicNET : AtomicEngine Namespace

VertexBuffer Class

Hardware vertex buffer.

Syntax

public class VertexBuffer : AObject

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 AObject.

Public Constructors

Documentation for this section has not yet been entered.
Construct. Optionally force headless (no GPU-side buffer) operation.

Public Fields

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

Public Properties

[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Dynamic bool . Documentation for this section has not yet been entered.
[read-only]
ElementMask uint . 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.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Locked bool . Documentation for this section has not yet been entered.
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
Shadowed bool . 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]
VertexCount uint . 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.)
static
csb_Atomic_VertexBuffer_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
GetBufferHash (uint) : long
Return buffer hash for building vertex declarations. Used internally.
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.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetElementMask () : uint
Return legacy vertex element mask. Note that both semantic and type must match the legacy element for a mask bit to be set.
GetElementOffset (VertexElementSemantic, byte) : uint
Return offset of a element within vertex, or M_MAX_UNSIGNED if does not exist.
GetElementOffset (VertexElementType, VertexElementSemantic, byte) : uint
Return offset of a element with specific type within vertex, or M_MAX_UNSIGNED if element does not exist.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetVertexCount () : uint
Return number of vertices.
GetVertexSize () : uint
Return vertex size in bytes.
static
GetVertexSize (uint) : uint
Return vertex size for a legacy vertex element bitmask.
HasElement (VertexElementSemantic, byte) : bool
Return whether has a specified element semantic.
HasElement (VertexElementType, VertexElementSemantic, byte) : bool
Return whether has an element semantic with specific type.
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.)
IsDynamic () : bool
Return whether is dynamic.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
IsLocked () : bool
Return whether is currently locked.
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.)
IsShadowed () : bool
Return whether CPU memory shadowing is enabled.
Lock (uint, uint, bool) : IntPtr
Documentation for this section has not yet been entered.
OnDeviceLost ()
Mark the buffer destroyed on graphics context destruction. May be a no-op depending on the API.
OnDeviceReset ()
Recreate the buffer and restore data if applicable. May be a no-op depending on the API.
Refs () : int
Return reference count. (Inherited from RefCounted.)
Release ()
Release buffer.
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.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetShadowed (bool)
Enable shadowing in CPU memory. Shadowing is forced on if the graphics subsystem does not exist.
SetSize (uint, uint, bool) : bool
Set size and vertex elements and dynamic mode using legacy element bitmask. Previous data will be lost.
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.)
Unlock ()
Unlock the buffer and apply changes to the GPU buffer.
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.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

VertexBuffer Constructor

Documentation for this section has not yet been entered.

Syntax

public VertexBuffer (bool forceHeadless)

Parameters

forceHeadless
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

VertexBuffer Constructor

Construct. Optionally force headless (no GPU-side buffer) operation.

Syntax

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

csb_Atomic_VertexBuffer_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

Dynamic Property

Documentation for this section has not yet been entered.

Syntax

public bool Dynamic { 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

ElementMask Property

Documentation for this section has not yet been entered.

Syntax

public uint ElementMask { 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

GetBufferHash Method

Return buffer hash for building vertex declarations. Used internally.

Syntax

public long GetBufferHash (uint streamIndex)

Parameters

streamIndex
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

GetElementMask Method

Return legacy vertex element mask. Note that both semantic and type must match the legacy element for a mask bit to be set.

Syntax

public uint GetElementMask ()

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

GetElementOffset Method

Return offset of a element within vertex, or M_MAX_UNSIGNED if does not exist.

Syntax

public uint GetElementOffset (VertexElementSemantic semantic, byte index)

Parameters

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

GetElementOffset Method

Return offset of a element with specific type within vertex, or M_MAX_UNSIGNED if element does not exist.

Syntax

public uint GetElementOffset (VertexElementType type, VertexElementSemantic semantic, byte index)

Parameters

type
Documentation for this section has not yet been entered.
semantic
Documentation for this section has not yet been entered.
index
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

GetVertexCount Method

Return number of vertices.

Syntax

public uint GetVertexCount ()

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

GetVertexSize Method

Return vertex size in bytes.

Syntax

public uint GetVertexSize ()

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

GetVertexSize Method

Return vertex size for a legacy vertex element bitmask.

Syntax

public static uint GetVertexSize (uint elementMask)

Parameters

elementMask
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

HasElement Method

Return whether has a specified element semantic.

Syntax

public bool HasElement (VertexElementSemantic semantic, byte index)

Parameters

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

HasElement Method

Return whether has an element semantic with specific type.

Syntax

public bool HasElement (VertexElementType type, VertexElementSemantic semantic, byte index)

Parameters

type
Documentation for this section has not yet been entered.
semantic
Documentation for this section has not yet been entered.
index
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

IsDynamic Method

Return whether is dynamic.

Syntax

public bool IsDynamic ()

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

IsLocked Method

Return whether is currently locked.

Syntax

public bool IsLocked ()

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

IsShadowed Method

Return whether CPU memory shadowing is enabled.

Syntax

public bool IsShadowed ()

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

Lock Method

Documentation for this section has not yet been entered.

Syntax

public IntPtr Lock (uint start, uint count, bool discard)

Parameters

start
Documentation for this section has not yet been entered.
count
Documentation for this section has not yet been entered.
discard
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

Locked Property

Documentation for this section has not yet been entered.

Syntax

public bool Locked { 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

OnDeviceLost Method

Mark the buffer destroyed on graphics context destruction. May be a no-op depending on the API.

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 buffer and restore data if applicable. May be a no-op depending on the API.

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 buffer.

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

SetShadowed Method

Enable shadowing in CPU memory. Shadowing is forced on if the graphics subsystem does not exist.

Syntax

public void SetShadowed (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

SetSize Method

Set size and vertex elements and dynamic mode using legacy element bitmask. Previous data will be lost.

Syntax

public bool SetSize (uint vertexCount, uint elementMask, bool dynamic)

Parameters

vertexCount
Documentation for this section has not yet been entered.
elementMask
Documentation for this section has not yet been entered.
dynamic
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

Shadowed Property

Documentation for this section has not yet been entered.

Syntax

public bool Shadowed { 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

Unlock Method

Unlock the buffer and apply changes to the GPU buffer.

Syntax

public void Unlock ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

VertexCount Property

Documentation for this section has not yet been entered.

Syntax

public uint VertexCount { 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