GpuCode

Description

abstract class Tinman.Gpu.GpuCode

This class is the base for GPU programs and provides a set of intrinsic functions that can be mapped to other GPU programming languages (like HLSL and GLSL) with zero or trivial effort.

A GPU program is a group of shader functions that reads data from one or more input resource object (such as IGpuBuffer or ITexture) and writes data to one or more output resource objects (such as IRenderTarget, IGpuBuffer or ITexture). If a class is derived from GpuCode, it becomes a GPU code class, which contains functions that will be executed by a GPU (after syntactic and semantic translation to GPU code, such as HLSL/GLSL, following by compilation and linking by the native graphics API). To define a shader function, a function of a GPU code class must be annotated with one of the following attributes, which turns the function into a pipeline stage:

Compute pipeline stages:
1. ComputeShader (required)
Graphics pipeline stages:
1. VertexShader (required)
2. GeometryShader (optional)
3. TessellatePatchShader (optional)
4. TessellateVertexShader (optional)
5. PixelShader (required)

Data may be passed between pipeline stages with struct values that are annotated with StageInOut. To pass data within a pipeline stage, struct values that are annotated with Stage may be used, in addition to values of the following types:

Simple:
bool, int, float
Vector:
float2, float3, float4
int2, int3, int4
Matrix:
float2x2, float3x3, float3x4, float4x4
Special:
FACE STREAM

The following attributes may be used to specify value semantics and custom behaviour:

Constant data may be fed into a GPU program via constant buffers, which are defined via class types that are annotated with ConstantBuffer. GPU code reads values from a constant buffer by accessing the static fields and CPU code writes values via the IRenderEffectParameters interface, where the mapping between from constant buffer field name to parameter slot is obtained via IRenderEffectParameters.ParameterDeclare. Usually, the mapping is handled internally by a RenderEffectParameters class and thus hidden from client code. Shader resource objects are specified in a way similar to how constant data is specified: via a class type that is annotated with ShaderResources. Global configuration data may be specified via class types that are annotated with the Configuration attribute. Configuration data is compile-time constant and may thus be used to implement conditional compilation.

Public / Constants

CCW

public constant CCW → (0:int32)

A shared option value.

See also: TessellateShaderAttribute.Primitive

CW

public constant CW → (1:int32)

A shared option value.

See also: TessellateShaderAttribute.Primitive

EQUAL

public constant EQUAL → (2:int32)

A shared option value.

See also: TessellateShaderAttribute.Scheme

EVEN

public constant EVEN → (3:int32)

A shared option value.

See also: TessellateShaderAttribute.Scheme

LINE

public constant LINE → (4:int32)

A shared option value.

See also: GeometryShaderAttribute.Input
GeometryShaderAttribute.Output
TessellateShaderAttribute.Primitive
TessellateShaderAttribute.Topology

ODD

public constant ODD → (5:int32)

A shared option value.

See also: TessellateShaderAttribute.Scheme

POINT

public constant POINT → (6:int32)

A shared option value.

See also: GeometryShaderAttribute.Input
GeometryShaderAttribute.Output
TessellateShaderAttribute.Primitive

QUAD

public constant QUAD → (7:int32)

A shared option value.

See also: TessellateShaderAttribute.Topology

TRIANGLE

public constant TRIANGLE → (8:int32)

A shared option value.

See also: GeometryShaderAttribute.Input
GeometryShaderAttribute.Output
TessellateShaderAttribute.Topology

Protected / Methods

abs

[Pure]
protected static method abs → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the absolute value of the given value (per component).

acos

[Pure]
protected static method acos → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the arc-cosine of the given value (per component).

asin

[Pure]
protected static method asin → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the arc-cosine of the given value (per component).

atan

[Pure]
protected static method atan → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the arc-tangent in the range [-pi/2..+pi/2] of the given value (per component).

atan2

[Pure]
protected static method atan2 → (2)

y ⁱⁿ : T: The first input value.
x ⁱⁿ : T: The second input value.
returns → T: The output value.

Computes the arc-tangent in the range [-pi..+pi] of the given values (y ⁱⁿ / x ⁱⁿ).

ceil

[Pure]
protected static method ceil → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value

Computes the smallest integral value that is greater than or equal to the given value (per component).

clamp

[Pure]
protected static method clamp → (3)

value ⁱⁿ : T: The input value.
min ⁱⁿ : T: The minimum bound (inclusive).
max ⁱⁿ : T: The maximum bound (inclusive).
returns → T: The output value.

Clamps the given value to the specified bounds (per component).

cos

[Pure]
protected static method cos → (1)

x ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the cosine of the given value (per component).

cross

[Pure]
protected static method cross → (2)

a ⁱⁿ : float3: The first input vector.
b ⁱⁿ : float3: The second input vector.
returns → float3: The output value.

Computes the cross product of the given vectors.

ddx

[Pure]
protected static method ddx → (1)

a ^ref : T: The value.
returns → T: The partial derivative of a ^ref.

Computes the partial derivative of the given value, along the pixel X-axis.

ddy

[Pure]
protected static method ddy → (1)

a ^ref : T: The value.
returns → T: The partial derivative of a ^ref.

Computes the partial derivative of the given value, along the pixel Y-axis.

dot

[Pure]
protected static method dot → (2)

a ⁱⁿ : T: The first input vector.
b ⁱⁿ : T: The second input vector.
returns → float32: The output value.

Computes the dot product of the given vectors.

exp

[Pure]
protected static method exp → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the value of e raised by the given value (per component).

floor

[Pure]
protected static method floor → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value

Computes the greatest integral value that is less than or equal to the given value (per component).

fmod

[Pure]
protected static method fmod → (2)

a ⁱⁿ : T: The dividend.
b ⁱⁿ : T: The divisor.
returns → T: The remainder R, defined as a = i * b + R, where i is the integral number with the greatest absolute value for which a has the same sign as R.

Computes the remainder of the division of a ⁱⁿ by b ⁱⁿ.

frac

[Pure]
protected static method frac → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the fractional part in the range [0..1[ of the given value (per component).

gxAtomicAdd

protected static method gxAtomicAdd → (3)

variable ^ref : int32: The variable to update.
delta ⁱⁿ : int32: The value to add to variable ^ref.
original ^out : int32: The value of variable ^ref before adding delta ⁱⁿ.

Adds delta ⁱⁿ to variable ^ref in an atomic operation.

gxDiscard

protected static method gxDiscard → ()

Discards the current pixel / fragment.

gxDiscardIf

protected static method gxDiscardIf → (1)

condition ⁱⁿ : bool: The condition value.

Discards the current pixel / fragment if condition ⁱⁿ is true.

gxDiscardNegative

protected static method gxDiscardNegative → (1)

value ⁱⁿ : float32: The condition value.

Discards the current pixel / fragment if value ⁱⁿ is negative.

gxEqual

[Pure]
protected static method gxEqual → (2)

a ⁱⁿ : int4: The first input value.
b ⁱⁿ : int4: The second input value.
returns → bool: true if the values are equal,
false if the values are different.

Checks if the given values are equal.

gxFace

[Pure]
protected static method gxFace → (1)

face ⁱⁿ : FACE: The special FACE value.
returns → float32: +1 for a front-facing primitive,
-1 for a back-facing primitive.

Checks if the current primitive is front-facing or back-facing.

See also: PixelShader

gxSizeOf

[Pure]
protected static method gxSizeOf → (2)

buffer ⁱⁿ : TEXTURE_2D_RW<T>: The buffer.
size ^out : int2: The buffer width and height, in elements.

Returns the size of the given buffer.

gxSizeOfLevel

[Pure]
protected static method gxSizeOfLevel → (3)

texture ⁱⁿ : TEXTURE_CUBE<T>: The buffer.
level ⁱⁿ : int32: The mipmap level.
size ^out : int32: The texture level size, in texels.

Returns the size of the given texture.

gxStreamAppend

[Pure]
protected static method gxStreamAppend → (2)

stream ⁱⁿ : STREAM<T>: The geometry stream.
value ⁱⁿ : T: The vertex to append.

Appends a vertex to the given geometry stream.

gxStreamReset

[Pure]
protected static method gxStreamReset → (1)

stream ⁱⁿ : STREAM<T>: The geometry stream.

Starts a new primitive on the given geometry stream.

gxSync

protected static method gxSync → ()

Synchronizes execution of all threads in a group and issued a memory barrier.

See also: ComputeShader

gxTexture2D

[Pure]
protected static method gxTexture2D → (2)

texture ⁱⁿ : TEXTURE_2D<T>: The texture to sample.
coords ⁱⁿ : float2: The texture coordinates.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTexture2DArray

[Pure]
protected static method gxTexture2DArray → (3)

texture ⁱⁿ : TEXTURE_2D_ARRAY<T>: The texture to sample.
slice ⁱⁿ : float32: The zero-based texture slice index.
coords ⁱⁿ : float2: The texture coordinates.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTexture2DArrayLod

[Pure]
protected static method gxTexture2DArrayLod → (4)

texture ⁱⁿ : TEXTURE_2D_ARRAY<T>: The texture to sample.
slice ⁱⁿ : float32: The zero-based texture slice index.
coords ⁱⁿ : float2: The texture coordinates.
lod ⁱⁿ : float32: The level-of-detail, given as the zero-based mipmap level index.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTexture2DGet

[Pure]
protected static method gxTexture2DGet → (2)

texture ⁱⁿ : TEXTURE_2D_RW<T>: The buffer resource.
xy ⁱⁿ : int2: The element XY-indices.
returns → T: The element value.

Fetches an element of the given buffer.

gxTexture2DLod

[Pure]
protected static method gxTexture2DLod → (3)

texture ⁱⁿ : TEXTURE_2D<T>: The texture to sample.
coords ⁱⁿ : float2: The texture coordinates.
lod ⁱⁿ : float32: The level-of-detail, given as the zero-based mipmap level index.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTexture2DSet

[Pure]
protected static method gxTexture2DSet → (3)

texture ⁱⁿ : TEXTURE_2D_RW<T>: The buffer resource.
xy ⁱⁿ : int2: The element XY-indices.
value ⁱⁿ : T: The element value to store.

Stores an element in the given buffer.

gxTextureCube

[Pure]
protected static method gxTextureCube → (2)

texture ⁱⁿ : TEXTURE_CUBE<T>: The texture to sample.
coords ⁱⁿ : float3: The texture coordinates.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTextureCubeLod

[Pure]
protected static method gxTextureCubeLod → (3)

texture ⁱⁿ : TEXTURE_CUBE<T>: The texture to sample.
coords ⁱⁿ : float3: The texture coordinates.
lod ⁱⁿ : float32: The level-of-detail, given as the zero-based mipmap level index.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTextures2D

[Pure]
protected static method gxTextures2D → (3)

texture ⁱⁿ : TEXTURE_2D<T> [ ]: The texture to sample.
index ⁱⁿ : int32: Index into texture ⁱⁿ.
coords ⁱⁿ : float2: The texture coordinates.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTextures2DArray

[Pure]
protected static method gxTextures2DArray → (4)

texture ⁱⁿ : TEXTURE_2D_ARRAY<T> [ ]: The texture to sample.
index ⁱⁿ : int32: Index into texture ⁱⁿ.
slice ⁱⁿ : float32: The zero-based texture slice index.
coords ⁱⁿ : float2: The texture coordinates.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTextures2DArrayLod

[Pure]
protected static method gxTextures2DArrayLod → (5)

texture ⁱⁿ : TEXTURE_2D_ARRAY<T> [ ]: The texture to sample.
index ⁱⁿ : int32: Index into texture ⁱⁿ.
slice ⁱⁿ : float32: The zero-based texture slice index.
coords ⁱⁿ : float2: The texture coordinates.
lod ⁱⁿ : float32: The level-of-detail, given as the zero-based mipmap level index.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTextures2DLod

[Pure]
protected static method gxTextures2DLod → (4)

texture ⁱⁿ : TEXTURE_2D<T> [ ]: The texture to sample.
index ⁱⁿ : int32: Index into texture ⁱⁿ.
coords ⁱⁿ : float2: The texture coordinates.
lod ⁱⁿ : float32: The level-of-detail, given as the zero-based mipmap level index.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTexturesCube

[Pure]
protected static method gxTexturesCube → (3)

texture ⁱⁿ : TEXTURE_CUBE<T> [ ]: The texture to sample.
index ⁱⁿ : int32: Index into texture ⁱⁿ.
coords ⁱⁿ : float3: The texture coordinates.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxTexturesCubeLod

[Pure]
protected static method gxTexturesCubeLod → (4)

texture ⁱⁿ : TEXTURE_CUBE<T> [ ]: The texture to sample.
index ⁱⁿ : int32: Index into texture ⁱⁿ.
coords ⁱⁿ : float3: The texture coordinates.
lod ⁱⁿ : float32: The level-of-detail, given as the zero-based mipmap level index.
returns → T: The texture sample.

Samples the given texture ⁱⁿ.

gxToFloat

[Pure]
protected static method gxToFloat → (1)

x ⁱⁿ : int32: The input value.
returns → float32: The output value.

Indicates that the given implicit value conversion is lossless.

gxToFloat2

_2 overloads

[Pure]
protected static method gxToFloat2¹ → (1)

x ⁱⁿ : float32: The input value.
returns → float2: The output value (x,x).

Performs a value conversion.

[Pure]
protected static method gxToFloat2² → (1)

v ⁱⁿ : int2: The input value.
returns → float2: The output value.

Performs a value conversion.

gxToFloat2x2ColumnMajor

_2 overloads

[Pure]
protected static method gxToFloat2x2ColumnMajor¹ → (2)

v1 ⁱⁿ : float2: First column vector.
v2 ⁱⁿ : float2: Second column vector.
returns → float2x2: The output 2x2 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat2x2ColumnMajor² → (4)

m11 ⁱⁿ : float32: First element of first column vector.
m21 ⁱⁿ : float32: Second element of first column vector.
m12 ⁱⁿ : float32: First element of second column vector.
m22 ⁱⁿ : float32: Second element of second column vector.
returns → float2x2: The output 2x2 matrix value.

Performs a value conversion.

gxToFloat2x2RowMajor

_2 overloads

[Pure]
protected static method gxToFloat2x2RowMajor¹ → (2)

v1 ⁱⁿ : float2: First row vector.
v2 ⁱⁿ : float2: Second row vector.
returns → float2x2: The output 2x2 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat2x2RowMajor² → (4)

m11 ⁱⁿ : float32: First element of first row vector.
m12 ⁱⁿ : float32: Second element of first row vector.
m21 ⁱⁿ : float32: First element of second row vector.
m22 ⁱⁿ : float32: Second element of second row vector.
returns → float2x2: The output 2x2 matrix value.

Performs a value conversion.

gxToFloat3

_2 overloads

[Pure]
protected static method gxToFloat3¹ → (1)

x ⁱⁿ : float32: The input value.
returns → float3: The output value (x,x,x).

Performs a value conversion.

[Pure]
protected static method gxToFloat3² → (1)

v ⁱⁿ : int3: The input value.
returns → float3: The output value.

Performs a value conversion.

gxToFloat3x3ColumnMajor

_2 overloads

[Pure]
protected static method gxToFloat3x3ColumnMajor¹ → (3)

v1 ⁱⁿ : float3: First column vector.
v2 ⁱⁿ : float3: Second column vector.
v3 ⁱⁿ : float3: Third column vector.
returns → float3x3: The output 3x3 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat3x3ColumnMajor² → (9)

m11 ⁱⁿ : float32: First element of first column vector.
m21 ⁱⁿ : float32: Second element of first column vector.
m31 ⁱⁿ : float32: Third element of first column vector.
m12 ⁱⁿ : float32: First element of second column vector.
m22 ⁱⁿ : float32: Second element of second column vector.
m32 ⁱⁿ : float32: Third element of second column vector.
m13 ⁱⁿ : float32: First element of third column vector.
m23 ⁱⁿ : float32: Second element of third column vector.
m33 ⁱⁿ : float32: Third element of third column vector.
returns → float3x3: The output 3x3 matrix value.

Performs a value conversion.

gxToFloat3x3RowMajor

_2 overloads

[Pure]
protected static method gxToFloat3x3RowMajor¹ → (3)

v1 ⁱⁿ : float3: First row vector.
v2 ⁱⁿ : float3: Second row vector.
v3 ⁱⁿ : float3: Third row vector.
returns → float3x3: The output 3x3 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat3x3RowMajor² → (9)

m11 ⁱⁿ : float32: First element of first row vector.
m12 ⁱⁿ : float32: Second element of first row vector.
m13 ⁱⁿ : float32: Third element of first row vector.
m21 ⁱⁿ : float32: First element of second row vector.
m22 ⁱⁿ : float32: Second element of second row vector.
m23 ⁱⁿ : float32: Third element of second row vector.
m31 ⁱⁿ : float32: First element of third row vector.
m32 ⁱⁿ : float32: Second element of third row vector.
m33 ⁱⁿ : float32: Third element of third row vector.
returns → float3x3: The output 3x3 matrix value.

Performs a value conversion.

gxToFloat3x4ColumnMajor

_2 overloads

[Pure]
protected static method gxToFloat3x4ColumnMajor¹ → (4)

v1 ⁱⁿ : float3: First column vector.
v2 ⁱⁿ : float3: Second column vector.
v3 ⁱⁿ : float3: Third column vector.
v4 ⁱⁿ : float3: Fourth column vector.
returns → float3x4: The output 3x4 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat3x4ColumnMajor² → (12)

m11 ⁱⁿ : float32: First element of first column vector.
m21 ⁱⁿ : float32: Second element of first column vector.
m31 ⁱⁿ : float32: Third element of first column vector.
m12 ⁱⁿ : float32: First element of second column vector.
m22 ⁱⁿ : float32: Second element of second column vector.
m32 ⁱⁿ : float32: Third element of second column vector.
m13 ⁱⁿ : float32: First element of third column vector.
m23 ⁱⁿ : float32: Second element of third column vector.
m33 ⁱⁿ : float32: Third element of third column vector.
m14 ⁱⁿ : float32: First element of fourth column vector.
m24 ⁱⁿ : float32: Second element of fourth column vector.
m34 ⁱⁿ : float32: Third element of fourth column vector.
returns → float3x4: The output 3x4 matrix value.

Performs a value conversion.

gxToFloat3x4RowMajor

_2 overloads

[Pure]
protected static method gxToFloat3x4RowMajor¹ → (3)

v1 ⁱⁿ : float4: First row vector.
v2 ⁱⁿ : float4: Second row vector.
v3 ⁱⁿ : float4: Third row vector.
returns → float3x4: The output 3x4 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat3x4RowMajor² → (12)

m11 ⁱⁿ : float32: First element of first row vector.
m12 ⁱⁿ : float32: Second element of first row vector.
m13 ⁱⁿ : float32: Third element of first row vector.
m14 ⁱⁿ : float32: Fourth element of first row vector.
m21 ⁱⁿ : float32: First element of second row vector.
m22 ⁱⁿ : float32: Second element of second row vector.
m23 ⁱⁿ : float32: Third element of second row vector.
m24 ⁱⁿ : float32: Fourth element of second row vector.
m31 ⁱⁿ : float32: First element of third row vector.
m32 ⁱⁿ : float32: Second element of third row vector.
m33 ⁱⁿ : float32: Third element of third row vector.
m34 ⁱⁿ : float32: Fourth element of third row vector.
returns → float3x4: The output 3x4 matrix value.

Performs a value conversion.

gxToFloat4

_2 overloads

[Pure]
protected static method gxToFloat4¹ → (1)

x ⁱⁿ : float32: The input value.
returns → float4: The output value (x,x,x,x).

Performs a value conversion.

[Pure]
protected static method gxToFloat4² → (1)

v ⁱⁿ : int4: The input value.
returns → float4: The output value.

Performs a value conversion.

gxToFloat4x4ColumnMajor

_2 overloads

[Pure]
protected static method gxToFloat4x4ColumnMajor¹ → (4)

v1 ⁱⁿ : float4: First column vector.
v2 ⁱⁿ : float4: Second column vector.
v3 ⁱⁿ : float4: Third column vector.
v4 ⁱⁿ : float4: Fourth column vector.
returns → float4x4: The output 4x4 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat4x4ColumnMajor² → (16)

m11 ⁱⁿ : float32: First element of first column vector.
m21 ⁱⁿ : float32: Second element of first column vector.
m31 ⁱⁿ : float32: Third element of first column vector.
m41 ⁱⁿ : float32: Fourth element of first column vector.
m12 ⁱⁿ : float32: First element of second column vector.
m22 ⁱⁿ : float32: Second element of second column vector.
m32 ⁱⁿ : float32: Third element of second column vector.
m42 ⁱⁿ : float32: Fourth element of second column vector.
m13 ⁱⁿ : float32: First element of third column vector.
m23 ⁱⁿ : float32: Second element of third column vector.
m33 ⁱⁿ : float32: Third element of third column vector.
m43 ⁱⁿ : float32: Fourth element of third column vector.
m14 ⁱⁿ : float32: First element of fourth column vector.
m24 ⁱⁿ : float32: Second element of fourth column vector.
m34 ⁱⁿ : float32: Third element of fourth column vector.
m44 ⁱⁿ : float32: Fourth element of fourth column vector.
returns → float4x4: The output 4x4 matrix value.

Performs a value conversion.

gxToFloat4x4RowMajor

_2 overloads

[Pure]
protected static method gxToFloat4x4RowMajor¹ → (4)

v1 ⁱⁿ : float4: First row vector.
v2 ⁱⁿ : float4: Second row vector.
v3 ⁱⁿ : float4: Third row vector.
v4 ⁱⁿ : float4: Fourth row vector.
returns → float4x4: The output 4x4 matrix value.

Performs a value conversion.

[Pure]
protected static method gxToFloat4x4RowMajor² → (16)

m11 ⁱⁿ : float32: First element of first row vector.
m12 ⁱⁿ : float32: Second element of first row vector.
m13 ⁱⁿ : float32: Third element of first row vector.
m14 ⁱⁿ : float32: Fourth element of first row vector.
m21 ⁱⁿ : float32: First element of second row vector.
m22 ⁱⁿ : float32: Second element of second row vector.
m23 ⁱⁿ : float32: Third element of second row vector.
m24 ⁱⁿ : float32: Fourth element of second row vector.
m31 ⁱⁿ : float32: First element of third row vector.
m32 ⁱⁿ : float32: Second element of third row vector.
m33 ⁱⁿ : float32: Third element of third row vector.
m34 ⁱⁿ : float32: Fourth element of third row vector.
m41 ⁱⁿ : float32: First element of fourth row vector.
m42 ⁱⁿ : float32: Second element of fourth row vector.
m43 ⁱⁿ : float32: Third element of fourth row vector.
m44 ⁱⁿ : float32: Fourth element of fourth row vector.
returns → float4x4: The output 4x4 matrix value.

Performs a value conversion.

gxToInt2

[Pure]
protected static method gxToInt2 → (1)

x ⁱⁿ : int32: The input value.
returns → int2: The output value (x,x).

Performs a value conversion.

gxToInt3

[Pure]
protected static method gxToInt3 → (1)

x ⁱⁿ : int32: The input value.
returns → int3: The output value (x,x,x).

Performs a value conversion.

gxToInt4

[Pure]
protected static method gxToInt4 → (1)

x ⁱⁿ : int32: The input value.
returns → int4: The output value (x,x,x,x).

Performs a value conversion.

length

[Pure]
protected static method length → (1)

vector ⁱⁿ : T: The vector.
returns → float32: The length of vector ⁱⁿ.

Returns the length of the given vector.

lerp

[Pure]
protected static method lerp → (3)

value0 ⁱⁿ : T: The first input value.
value1 ⁱⁿ : T: The first input value.
factor ⁱⁿ : T: The interpolation factor: 0 maps to value0 ⁱⁿ, 1 maps to value1 ⁱⁿ.
returns → T: The output value.

Linearly interpolates between the given values (per component).

log

[Pure]
protected static method log → (1)

value ⁱⁿ : T: The input scalar or vector.
returns → T: The output scalar or vector.

Computes the natural logarithm of the given value.

log2

[Pure]
protected static method log2 → (1)

value ⁱⁿ : T: The input scalar or vector.
returns → T: The output scalar or vector.

Computes the logarithm of base 2 of the given value.

max

[Pure]
protected static method max → (2)

a ⁱⁿ : T: The first input value.
b ⁱⁿ : T: The second input value.
returns → T: The output value.

Computes the maximum of the given values (per component).

min

[Pure]
protected static method min → (2)

a ⁱⁿ : T: The first input value.
b ⁱⁿ : T: The second input value.
returns → T: The output value.

Computes the minimum of the given values (per component).

mul

_7 overloads

[Pure]
protected static method mul¹ → (2)

m ⁱⁿ : float2x2: The matrix.
v ⁱⁿ : float2: The column-vector.
returns → float2: The resulting column-vector.

Multiplies the given matrix and column-vector.

This is the standard form of a multiplication of a matrix and a vector:

| m11 m12 |   | x |   | m11 * x + m12 * y |
| m21 m22 | * | y | = | m21 * x + m22 * y |

[Pure]
protected static method mul² → (2)

m ⁱⁿ : float3x3: The matrix.
v ⁱⁿ : float3: The column-vector.
returns → float3: The resulting column-vector.

Multiplies the given matrix and column-vector.

This is the standard form of a multiplication of a matrix and a vector:

| m11 m12 m13 |   | x |   | m11 * x + m12 * y + m13 * z |
| m21 m22 m23 | * | y | = | m21 * x + m22 * y + m23 * z |
| m31 m32 m33 |   | z |   | m31 * x + m32 * y + m33 * z |

[Pure]
protected static method mul³ → (2)

m ⁱⁿ : float3x4: The matrix.
v ⁱⁿ : float4: The column-vector.
returns → float3: The resulting column-vector.

Multiplies the given matrix and column-vector.

This is the standard form of a multiplication of a matrix and a vector:

| m11 m12 m13 m14 |   | x |   | m11 * x + m12 * y + m13 * z + m14 * w |
| m21 m22 m23 m24 | * | y | = | m21 * x + m22 * y + m23 * z + m24 * w |
| m31 m32 m33 m34 |   | z |   | m31 * x + m32 * y + m33 * z + m34 * w |

[Pure]
protected static method mul⁴ → (2)

m ⁱⁿ : float4x4: The matrix.
v ⁱⁿ : float4: The column-vector.
returns → float4: The resulting column-vector.

Multiplies the given matrix and column-vector.

This is the standard form of a multiplication of a matrix and a vector:

| m11 m12 m13 m14 |   | x |   | m11 * x + m12 * y + m13 * z + m14 * w |
| m21 m22 m23 m24 | * | y | = | m21 * x + m22 * y + m23 * z + m24 * w |
| m31 m32 m33 m34 |   | z |   | m31 * x + m32 * y + m33 * z + m34 * w |
| m41 m42 m43 m44 |   | w |   | m41 * x + m42 * y + m43 * z + m44 * w |

[Pure]
protected static method mul⁵ → (2)

v ⁱⁿ : float2: The row-vector.
m ⁱⁿ : float2x2: The matrix.
returns → float2: The resulting row-vector.

Multiplies the given row-vector and matrix.

This is the transposed form of a multiplication of a matrix and a vector:

| x |T    | m11 m12 |   | m11 * x + m21 * y |T
| y |  *  | m21 m22 | = | m12 * x + m22 * y |

Calling mul² with the transpose of m ⁱⁿ yields the same result.

[Pure]
protected static method mul⁶ → (2)

v ⁱⁿ : float3: The row-vector.
m ⁱⁿ : float3x3: The matrix.
returns → float3: The resulting row-vector.

Multiplies the given row-vector and matrix.

This is the transposed form of a multiplication of a matrix and a vector:

| x |T    | m11 m12 m13 |   | m11 * x + m21 * y + m31 * z |T
| y |  *  | m21 m22 m23 | = | m12 * x + m22 * y + m32 * z |
| z |     | m31 m32 m33 |   | m13 * x + m23 * y + m32 * z |

Calling mul² with the transpose of m ⁱⁿ yields the same result.

[Pure]
protected static method mul⁷ → (2)

v ⁱⁿ : float4: The row-vector.
m ⁱⁿ : float4x4: The matrix.
returns → float4: The resulting row-vector.

Multiplies the given row-vector and matrix.

This is the transposed form of a multiplication of a matrix and a vector:

| x |T    | m11 m12 m13 m14 |   | m11 * x + m21 * y + m31 * z + m41 * w |T
| y |  *  | m21 m22 m23 m24 | = | m12 * x + m22 * y + m32 * z + m42 * w |
| z |     | m31 m32 m33 m34 |   | m13 * x + m23 * y + m32 * z + m43 * w |
| w |     | m41 m42 m43 m44 |   | m14 * x + m24 * y + m33 * z + m44 * w |

Calling mul⁴ with the transpose of m ⁱⁿ yields the same result.

normalize

_2 overloads

[Pure]
protected static method normalize¹ → (1)

vector ⁱⁿ : float3: The input vector.
returns → float3: The output vector.

Normalizes the given vector to unit-length.

[Pure]
protected static method normalize² → (1)

vector ⁱⁿ : float2: The input vector.
returns → float2: The output vector.

Normalizes the given vector to unit-length.

pow

[Pure]
protected static method pow → (2)

x ⁱⁿ : T: The value to raise by y ⁱⁿ.
y ⁱⁿ : T: The power to raise x ⁱⁿ by.
returns → T: The output scalar or vector.

Computes the specified value raised to the specified power.

reflect

[Pure]
protected static method reflect → (2)

i ⁱⁿ : float3: The incident ray.
n ⁱⁿ : float3: The surface normal.
returns → float3: The reflection vector.

Computes a reflection vector using an incident ray and a surface normal:

result := i - n * 2 * dot(i, n)

round

[Pure]
protected static method round → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Rounds the specified value to the nearest integer.

saturate

[Pure]
protected static method saturate → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Clamps the given value to the range [0..1] (per component).

sign

[Pure]
protected static method sign → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes -1, 0 or +1, depending on whether the given value is less than zero, equal to zero or greater than zero (per component).

sin

[Pure]
protected static method sin → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the sine of the given value (per component).

smoothstep

[Pure]
protected static method smoothstep → (3)

min ⁱⁿ : T: The minimum bound.
max ⁱⁿ : T: The maximum bound.
value ⁱⁿ : T: The input value.
returns → T: The output value in the range.

Computes a smooth interpolation in the range [0..1], when value ⁱⁿ is within in the range [min ⁱⁿ..max ⁱⁿ].

sqrt

[Pure]
protected static method sqrt → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the square root of the given value (per component).

tan

[Pure]
protected static method tan → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Computes the tangent of the given value (per component).

transpose

[Pure]
protected static method transpose → (1)

matrix ⁱⁿ : T: The input matrix
returns → T: The transpose of matrix ⁱⁿ.

Returns the transpose of the given square matrix.

trunc

[Pure]
protected static method trunc → (1)

value ⁱⁿ : T: The input value.
returns → T: The output value.

Truncates the given value to its integral part (per component).

GpuCode

Description

Public / Constants

CCW

CW

EQUAL

EVEN

LINE

ODD

POINT

QUAD

TRIANGLE

Protected / Methods

abs

acos

asin

atan

atan2

ceil

clamp

cos

cross

ddx

ddy

dot

exp

floor

fmod

frac

gx​Atomic​Add

gx​Discard

gx​Discard​If

gx​Discard​Negative

gx​Equal

gx​Face

gx​Size​Of

gx​Size​Of​Level

gx​Stream​Append

gx​Stream​Reset

gx​Sync

gx​Texture2​D

gx​Texture2​DArray

gx​Texture2​DArray​Lod

gx​Texture2​DGet

gx​Texture2​DLod

gx​Texture2​DSet

gx​Texture​Cube

gx​Texture​Cube​Lod

gx​Textures2​D

gx​Textures2​DArray

gx​Textures2​DArray​Lod

gx​Textures2​DLod

gx​Textures​Cube

gx​Textures​Cube​Lod

gx​To​Float

gx​To​Float2

gx​To​Float2x2​Column​Major

gx​To​Float2x2​Row​Major

gx​To​Float3

gx​To​Float3x3​Column​Major

gx​To​Float3x3​Row​Major

gx​To​Float3x4​Column​Major

gx​To​Float3x4​Row​Major

gx​To​Float4

gx​To​Float4x4​Column​Major

gx​To​Float4x4​Row​Major

gx​To​Int2

gx​To​Int3

gx​To​Int4

length

lerp

log

log2

max

min

mul

normalize

pow

reflect

round

gxAtomicAdd

gxDiscard

gxDiscardIf

gxDiscardNegative

gxEqual

gxFace

gxSizeOf

gxSizeOfLevel

gxStreamAppend

gxStreamReset

gxSync

gxTexture2D

gxTexture2DArray

gxTexture2DArrayLod

gxTexture2DGet

gxTexture2DLod

gxTexture2DSet

gxTextureCube

gxTextureCubeLod

gxTextures2D

gxTextures2DArray

gxTextures2DArrayLod

gxTextures2DLod

gxTexturesCube

gxTexturesCubeLod

gxToFloat

gxToFloat2

gxToFloat2x2ColumnMajor

gxToFloat2x2RowMajor

gxToFloat3

gxToFloat3x3ColumnMajor

gxToFloat3x3RowMajor

gxToFloat3x4ColumnMajor

gxToFloat3x4RowMajor

gxToFloat4

gxToFloat4x4ColumnMajor

gxToFloat4x4RowMajor

gxToInt2

gxToInt3

gxToInt4