Class VfxVariableDescription

Namespace: ValveResourceFormat.CompiledShader
Assembly: ValveResourceFormat.dll

Represents a variable description in a VFX shader program.

public class VfxVariableDescription : ShaderDataBlock

Inheritance

object ← ShaderDataBlock ← VfxVariableDescription

Inherited Members

ShaderDataBlock.Start, ShaderDataBlock.ReadStringWithMaxLength(BinaryReader, int)

Constructors

VfxVariableDescription(KVObject, int)

Initializes a new instance of the class from data.

public VfxVariableDescription(KVObject data, int blockIndex)

Parameters

data KVObject

The containing variable data.

blockIndex int

The block index for this variable.

VfxVariableDescription(BinaryReader, int, int)

Initializes a new instance of the class from a binary stream.

public VfxVariableDescription(BinaryReader datareader, int blockIndex, int vcsVersion)

Parameters

datareader BinaryReader

The binary reader to read from.

blockIndex int

The block index for this variable.

vcsVersion int

The VCS file version.

Fields

FloatInf

Float infinity value used for min/max ranges.

public static readonly float FloatInf

Field Value

float

IntInf

Integer infinity value used for min/max ranges.

public static readonly int IntInf

Field Value

int

Properties

AllowLayerOverride

Gets whether layer override is allowed.

public bool AllowLayerOverride { get; }

Property Value

bool

BlockIndex

Gets the block index of this variable.

public int BlockIndex { get; }

Property Value

int

ChannelCount

Gets the number of texture channels.

public int ChannelCount { get; }

Property Value

int

ChannelIndices

Gets the channel indices for texture variables.

public int[] ChannelIndices { get; }

Property Value

int[]

ColorMode

Gets the color mode for texture variables.

public int ColorMode { get; }

Property Value

int

ContextStateAffectedByVariable

Gets the context state affected by this variable.

public int ContextStateAffectedByVariable { get; }

Property Value

int

DefaultInputTexture

Gets the default input texture name.

public string DefaultInputTexture { get; }

Property Value

string

DescriptorSet

Gets the descriptor set index.

public uint DescriptorSet { get; }

Property Value

uint

DynExp

Gets the compiled dynamic expression bytecode.

public byte[] DynExp { get; }

Property Value

byte[]

ExtConstantBufferId

Gets the external constant buffer ID.

public int ExtConstantBufferId { get; }

Property Value

int

Flags

Gets the variable flags.

public VariableFlags Flags { get; }

Property Value

VariableFlags

FloatDefs

Gets the float default values (up to 4 components).

public float[] FloatDefs { get; }

Property Value

float[]

FloatMaxs

Gets the float maximum values (up to 4 components).

public float[] FloatMaxs { get; }

Property Value

float[]

FloatMins

Gets the float minimum values (up to 4 components).

public float[] FloatMins { get; }

Property Value

float[]

HasDynamicExpression

Gets whether this variable has a dynamic expression.

public bool HasDynamicExpression { get; }

Property Value

bool

ImageFormat

Gets the image format for texture variables.

public ImageFormat ImageFormat { get; }

Property Value

ImageFormat

ImageProcessor

Gets the image processing command for texture variables.

public string ImageProcessor { get; }

Property Value

string

ImageSuffix

Gets the image file suffix for texture variables.

public string ImageSuffix { get; }

Property Value

string

IntDefs

Gets the integer default values (up to 4 components).

public int[] IntDefs { get; }

Property Value

int[]

IntMaxs

Gets the integer maximum values (up to 4 components).

public int[] IntMaxs { get; }

Property Value

int[]

IntMins

Gets the integer minimum values (up to 4 components).

public int[] IntMins { get; }

Property Value

int[]

IsLayerConstant

Gets whether this is a layer constant.

public bool IsLayerConstant { get; }

Property Value

bool

LayerId

Gets the layer ID for this variable.

public byte LayerId { get; }

Property Value

byte

MaxRes

Gets the maximum resolution for texture variables.

public int MaxRes { get; }

Property Value

int

MinPrecisionBits

Gets the minimum precision bits required for this variable.

public int MinPrecisionBits { get; }

Property Value

int

Name

Gets the variable name.

public string Name { get; }

Property Value

string

RegisterElements

Gets the number of register elements.

public int RegisterElements { get; }

Property Value

int

RegisterOffset

Gets the register offset.

public uint RegisterOffset { get; }

Property Value

uint

RegisterType

Gets the register type for this variable.

public VfxRegisterType RegisterType { get; }

Property Value

VfxRegisterType

SourceIndex

Gets the source index for this variable.

public int SourceIndex { get; }

Property Value

int

SrgbRead

Gets a value indicating whether hardware sRGB reads are enabled for this variable.

public bool SrgbRead { get; }

Property Value

bool

StringData

Gets the string data associated with this variable.

public string StringData { get; }

Property Value

string

UiGroup

Gets the UI group for this variable.

public UiGroup UiGroup { get; }

Property Value

UiGroup

UiStep

Gets the UI step value for this variable.

public float UiStep { get; }

Property Value

float

UiType

Gets the UI type for this variable.

public UiType UiType { get; }

Property Value

UiType

UiVisibilityExp

Gets the compiled UI visibility expression bytecode.

public byte[] UiVisibilityExp { get; }

Property Value

byte[]

VariableSource

Gets the variable source type.

public VfxVariableSourceType VariableSource { get; }

Property Value

VfxVariableSourceType

VfxType

Gets the VFX variable type.

public VfxVariableType VfxType { get; }

Property Value

VfxVariableType