s&box docs
API ReferenceSandbox

public class Sandbox.RenderAttributes

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 ;

Broader workflow and conceptual references connected to this API.

Variables

Variables are useful for making your Graph easier to follow and understand, while also giving the option to expose certain values to the Material Editor and Code.

Constructors

Showing 1 constructors

Methods

Showing 52 methods

protected virtual override void Finalize()

public Angles GetAngles(Sandbox.StringToken name, Angles defaultValue = null)

Get a vector4 value - else defaultValue if missing

Parameters

  • defaultValue: Default: null

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

Get a bool value - else defaultValue if missing

Parameters

  • defaultValue: Default: False

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

Parameters

  • defaultValue: Default: False

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

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

Parameters

  • defaultValue: Default: 0

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

Get a float value - else defaultValue if missing

Parameters

  • defaultValue: Default: 0

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

Get a int value - else defaultValue if missing

Parameters

  • defaultValue: Default: 0

public Matrix GetMatrix(Sandbox.StringToken name, Matrix defaultValue = null)

Get a matrix value - else defaultValue if missing

Parameters

  • defaultValue: Default: null

public Vector3 GetVector(Sandbox.StringToken name, Vector3 defaultValue = null)

Get a vector3 value - else defaultValue if missing

Parameters

  • defaultValue: Default: null

public Vector4 GetVector4(Sandbox.StringToken name, Vector4 defaultValue = null)

Get a vector4 value - else defaultValue if missing

Parameters

  • defaultValue: Default: null

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

Metadata

FieldValue
NamespaceSandbox
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.RenderAttributes

RectInt

Previous Page

Renderer

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 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, 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, 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