AtomicNET : AtomicEngine Namespace

ShaderVariation Class

Vertex or pixel shader on the GPU.

Syntax

public class ShaderVariation : RefCounted

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

Public Constructors

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

Public Fields

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

Public Properties

[read-only]
CompilerOutput string . Documentation for this section has not yet been entered.
Defines string . Documentation for this section has not yet been entered.
[read-only]
DefinesClipPlane string . Documentation for this section has not yet been entered.
[read-only]
ElementHash long . Documentation for this section has not yet been entered.
[read-only]
FullName string . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
Name string . 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.)
[read-only]
Owner Shader . Documentation for this section has not yet been entered.
[read-only]
ShaderType ShaderType . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

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.)
Create () : bool
Compile the shader. Return true if successful.
static
csb_Atomic_ShaderVariation_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
GetCompilerOutput () : string
Return compile error/warning string.
GetDefines () : string
Return defines.
GetDefinesClipPlane () : string
Return defines with the CLIPPLANE define appended. Used internally on Direct3D11 only, will be empty on other APIs.
GetElementHash () : long
Return vertex element hash.
GetFullName () : string
Return full shader name.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetName () : string
Return shader name.
GetOwner () : Shader
Return the owner resource.
GetShaderType () : ShaderType
Return shader type.
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
HasParameter (StringHash) : bool
Return whether uses a parameter. Not applicable on OpenGL, where this information is contained in ShaderProgram instead.
HasTextureUnit (TextureUnit) : bool
Return whether uses a texture unit (only for pixel shaders.) Not applicable on OpenGL, where this information is contained in ShaderProgram instead.
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
OnDeviceLost ()
Mark the GPU resource destroyed on graphics context destruction.
Refs () : int
Return reference count. (Inherited from RefCounted.)
Release ()
Release the shader.
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.)
SetDefines (string)
Set defines.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetName (string)
Set name.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

ShaderVariation Constructor

Construct.

Syntax

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

ShaderVariation Constructor

Documentation for this section has not yet been entered.

Syntax

public ShaderVariation (Shader owner, ShaderType type)

Parameters

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

CompilerOutput Property

Documentation for this section has not yet been entered.

Syntax

public string CompilerOutput { 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

Create Method

Compile the shader. Return true if successful.

Syntax

public bool Create ()

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_ShaderVariation_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

Defines Property

Documentation for this section has not yet been entered.

Syntax

public string Defines { 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

DefinesClipPlane Property

Documentation for this section has not yet been entered.

Syntax

public string DefinesClipPlane { 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

ElementHash Property

Documentation for this section has not yet been entered.

Syntax

public long ElementHash { 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

FullName Property

Documentation for this section has not yet been entered.

Syntax

public string FullName { 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

GetCompilerOutput Method

Return compile error/warning string.

Syntax

public string GetCompilerOutput ()

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

GetDefines Method

Return defines.

Syntax

public string GetDefines ()

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

GetDefinesClipPlane Method

Return defines with the CLIPPLANE define appended. Used internally on Direct3D11 only, will be empty on other APIs.

Syntax

public string GetDefinesClipPlane ()

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

GetElementHash Method

Return vertex element hash.

Syntax

public long GetElementHash ()

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

GetFullName Method

Return full shader name.

Syntax

public string GetFullName ()

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

GetName Method

Return shader name.

Syntax

public string GetName ()

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

GetOwner Method

Return the owner resource.

Syntax

public Shader GetOwner ()

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

GetShaderType Method

Return shader type.

Syntax

public ShaderType GetShaderType ()

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

HasParameter Method

Return whether uses a parameter. Not applicable on OpenGL, where this information is contained in ShaderProgram instead.

Syntax

public bool HasParameter (StringHash param)

Parameters

param
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

HasTextureUnit Method

Return whether uses a texture unit (only for pixel shaders.) Not applicable on OpenGL, where this information is contained in ShaderProgram instead.

Syntax

public bool HasTextureUnit (TextureUnit unit)

Parameters

unit
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

Name Property

Documentation for this section has not yet been entered.

Syntax

public string Name { 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

OnDeviceLost Method

Mark the GPU resource destroyed on graphics 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

Owner Property

Documentation for this section has not yet been entered.

Syntax

public Shader Owner { 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

Release Method

Release the shader.

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

SetDefines Method

Set defines.

Syntax

public void SetDefines (string defines)

Parameters

defines
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

SetName Method

Set name.

Syntax

public void SetName (string name)

Parameters

name
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

ShaderType Property

Documentation for this section has not yet been entered.

Syntax

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