s&box docs
API ReferenceSandbox

RenderAttributesclass

RenderAttributes are a set of values that are passed to the renderer. They can be a variety of primitive types, textures, samplers or buffers. You can access attributes in the shader by binding them to a variable: float4 CornerRadius ; Texture2D g_tColor ;

object→RenderAttributes
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.RenderAttributes

Constructors1

Showing 1 constructors

Methods55

Showing 55 methods

public void Clear()PUBLIC

Returns:void—

protected virtual override void Finalize()PROTECTEDVIRTUALOVERRIDE

Returns:void—

public bool GetBool(Sandbox.StringToken name, bool defaultValue = False)PUBLIC

Get a bool value - else defaultValue if missing

ParameterTypeDescription
nameStringToken—
defaultValue = Falsebool—
Returns:bool—

public bool GetComboBool(Sandbox.StringToken k, bool defaultValue = False)PUBLIC

ParameterTypeDescription
kStringToken—
defaultValue = Falsebool—
Returns:bool—

public T GetComboEnum(Sandbox.StringToken k, T defaultValue)PUBLIC

ParameterTypeDescription
kStringToken—
defaultValueT—
Returns:T—

public int GetComboInt(Sandbox.StringToken k, int defaultValue = 0)PUBLIC

ParameterTypeDescription
kStringToken—
defaultValue = 0int—
Returns:int—

public float GetFloat(Sandbox.StringToken name, float defaultValue = 0)PUBLIC

Get a float value - else defaultValue if missing

ParameterTypeDescription
nameStringToken—
defaultValue = 0float—
Returns:float—

public int GetInt(Sandbox.StringToken name, int defaultValue = 0)PUBLIC

Get a int value - else defaultValue if missing

ParameterTypeDescription
nameStringToken—
defaultValue = 0int—
Returns:int—

public uint GetUInt(Sandbox.StringToken name, uint defaultValue = 0)PUBLIC

Get a uint value - else defaultValue if missing

ParameterTypeDescription
nameStringToken—
defaultValue = 0uint—
Returns:uint—

public void SetComboEnum(Sandbox.StringToken k, T value)PUBLIC

ParameterTypeDescription
kStringToken—
valueT—
Returns:void—

Related Guides

→Variables

Shrink()

Previous Page

Clear()

Next Page

On this page

Constructorspublic RenderAttributes()Methodspublic System.Void Clear()protected virtual override System.Void Finalize()public Angles GetAngles(Sandbox.StringToken name, Angles defaultValue = null)public System.Boolean GetBool(Sandbox.StringToken name, System.Boolean defaultValue = False)public System.Boolean GetComboBool(Sandbox.StringToken k, System.Boolean defaultValue = False)public T GetComboEnum(Sandbox.StringToken k, T defaultValue)public System.Int32 GetComboInt(Sandbox.StringToken k, System.Int32 defaultValue = 0)public System.Single GetFloat(Sandbox.StringToken name, System.Single defaultValue = 0)public System.Int32 GetInt(Sandbox.StringToken name, System.Int32 defaultValue = 0)public Matrix GetMatrix(Sandbox.StringToken name, Matrix defaultValue = null)public Sandbox.Texture GetTexture(Sandbox.StringToken name, Sandbox.Texture defaultValue = null)public Sandbox.Texture GetTexture(System.String name, Sandbox.Texture defaultValue = null)public System.UInt32 GetUInt(Sandbox.StringToken name, System.UInt32 defaultValue = 0)public Vector3 GetVector(Sandbox.StringToken name, Vector3 defaultValue = null)public Vector4 GetVector4(Sandbox.StringToken name, Vector4 defaultValue = null)public System.Void Set(Sandbox.StringToken k, Angles value)public System.Void Set(Sandbox.StringToken k, Matrix value)public System.Void Set(Sandbox.StringToken k, Sandbox.GpuBuffer value)public System.Void Set(Sandbox.StringToken k, Sandbox.Rendering.SamplerState value)public System.Void Set(Sandbox.StringToken k, Sandbox.Texture value, System.Int32 mip = -1)public System.Void Set(Sandbox.StringToken k, System.Boolean value)public System.Void Set(Sandbox.StringToken k, System.Double value)public System.Void Set(Sandbox.StringToken k, System.Int32 value)public System.Void Set(Sandbox.StringToken k, System.Single value)public System.Void Set(Sandbox.StringToken k, System.String value)public System.Void Set(Sandbox.StringToken k, System.UInt32 value)public System.Void Set(Sandbox.StringToken k, Vector2 value)public System.Void Set(Sandbox.StringToken k, Vector2Int value)public System.Void Set(Sandbox.StringToken k, Vector3 value)public System.Void Set(Sandbox.StringToken k, Vector3Int value)public System.Void Set(Sandbox.StringToken k, Vector4 value)public System.Void Set(System.String k, Angles value)public System.Void Set(System.String k, Matrix value)public System.Void Set(System.String k, Sandbox.Texture value, System.Int32 mip = -1)public System.Void Set(System.String k, System.Boolean value)public System.Void Set(System.String k, System.Double value)public System.Void Set(System.String k, System.Int32 value)public System.Void Set(System.String k, System.Single value)public System.Void Set(System.String k, System.String value)public System.Void Set(System.String k, System.UInt32 value)public System.Void Set(System.String k, Vector2 value)public System.Void Set(System.String k, Vector2Int value)public System.Void Set(System.String k, Vector3 value)public System.Void Set(System.String k, Vector3Int value)public System.Void Set(System.String k, Vector4 value)public System.Void SetCombo(Sandbox.StringToken k, System.Boolean value)public System.Void SetCombo(Sandbox.StringToken k, System.Int32 value)public System.Void SetCombo(System.String k, System.Boolean value)public System.Void SetCombo(System.String k, System.Enum value)public System.Void SetCombo(System.String k, System.Int32 value)public System.Void SetComboEnum(Sandbox.StringToken k, T value)public System.Void SetData(Sandbox.StringToken k, T value)public System.Void SetData(Sandbox.StringToken k, T[] value)public System.Void SetData(Sandbox.StringToken k, System.Collections.Generic.List`1<T> value)public System.Void SetData(Sandbox.StringToken k, System.Span`1<T> value)Metadata