Class TMP_BaseShaderGUI

Base class for TextMesh Pro shader GUIs.

Inheritance

object

ShaderGUI

TMP_BaseShaderGUI

TMP_BitmapShaderGUI

TMP_SDFShaderGUI

Inherited Members

ShaderGUI.OnMaterialPreviewGUI(MaterialEditor, Rect, GUIStyle)

ShaderGUI.OnMaterialInteractivePreviewGUI(MaterialEditor, Rect, GUIStyle)

ShaderGUI.OnMaterialPreviewSettingsGUI(MaterialEditor)

ShaderGUI.OnClosed(Material)

ShaderGUI.ValidateMaterial(Material)

ShaderGUI.FindProperty(string, MaterialProperty[])

ShaderGUI.FindProperty(string, MaterialProperty[], bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: TMPro.EditorUtilities

Assembly: Unity.TextMeshPro.Editor.dll

Syntax

public abstract class TMP_BaseShaderGUI : ShaderGUI

Fields

m_Editor

Declaration

protected MaterialEditor m_Editor

Field Value

Type	Description
MaterialEditor

m_Material

Declaration

protected Material m_Material

Field Value

Type	Description
Material

m_Properties

Declaration

protected MaterialProperty[] m_Properties

Field Value

Type	Description
MaterialProperty[]

s_CullingTypeLabels

Declaration

protected static GUIContent[] s_CullingTypeLabels

Field Value

Type	Description
GUIContent[]

s_DebugExtended

Declaration

protected static bool s_DebugExtended

Field Value

Type	Description
bool

s_LbrtVectorLabels

Declaration

protected static GUIContent[] s_LbrtVectorLabels

Field Value

Type	Description
GUIContent[]

s_XywhVectorLabels

Declaration

protected static GUIContent[] s_XywhVectorLabels

Field Value

Type	Description
GUIContent[]

Methods

AssignNewShaderToMaterial(Material, Shader, Shader)

This method is called when a new shader has been selected for a Material.

Declaration

public override void AssignNewShaderToMaterial(Material material, Shader oldShader, Shader newShader)

Parameters

Type	Name	Description
Material	material	The material the newShader should be assigned to.
Shader	oldShader	Previous shader.
Shader	newShader	New shader to assign to the material.

Overrides

ShaderGUI.AssignNewShaderToMaterial(Material, Shader, Shader)

BeginPanel(string, bool)

Declaration

protected bool BeginPanel(string panel, bool expanded)

Parameters

Type	Name	Description
string	panel
bool	expanded

Returns

Type	Description
bool

BeginPanel(string, ShaderFeature, bool, bool)

Declaration

protected bool BeginPanel(string panel, TMP_BaseShaderGUI.ShaderFeature feature, bool expanded, bool readState = true)

Parameters

Type	Name	Description
string	panel
TMP_BaseShaderGUI.ShaderFeature	feature
bool	expanded
bool	readState

Returns

Type	Description
bool

DoColor(string, string)

Declaration

protected void DoColor(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

DoCubeMap(string, string)

Declaration

protected void DoCubeMap(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

DoFloat(string, string)

Declaration

protected void DoFloat(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

DoGUI()

Override this method to create the specific shader GUI.

Declaration

protected abstract void DoGUI()

DoOffset(string, string)

Declaration

protected void DoOffset(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

DoPopup(string, string, GUIContent[])

Declaration

protected void DoPopup(string name, string label, GUIContent[] options)

Parameters

Type	Name	Description
string	name
string	label
GUIContent[]	options

DoSlider(string, string)

Declaration

protected void DoSlider(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

DoSlider(string, string, string)

Declaration

protected void DoSlider(string propertyName, string propertyField, string label)

Parameters

Type	Name	Description
string	propertyName
string	propertyField
string	label

DoSlider(string, string, Vector2, string)

Declaration

protected void DoSlider(string propertyName, string propertyField, Vector2 range, string label)

Parameters

Type	Name	Description
string	propertyName
string	propertyField
Vector2	range
string	label

DoSlider(string, Vector2, string)

Declaration

protected void DoSlider(string name, Vector2 range, string label)

Parameters

Type	Name	Description
string	name
Vector2	range
string	label

DoTexture2D(string, string, bool, string[])

Declaration

protected void DoTexture2D(string name, string label, bool withTilingOffset = false, string[] speedNames = null)

Parameters

Type	Name	Description
string	name
string	label
bool	withTilingOffset
string[]	speedNames

DoToggle(string, string)

Declaration

protected void DoToggle(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

DoUVSpeed(Rect, string[])

Declaration

protected void DoUVSpeed(Rect rect, string[] names)

Parameters

Type	Name	Description
Rect	rect
string[]	names

DoVector(string, string, GUIContent[])

Declaration

protected void DoVector(string name, string label, GUIContent[] subLabels)

Parameters

Type	Name	Description
string	name
string	label
GUIContent[]	subLabels

DoVector2(string, string)

Declaration

protected void DoVector2(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

DoVector3(string, string)

Declaration

protected void DoVector3(string name, string label)

Parameters

Type	Name	Description
string	name
string	label

EndPanel()

Declaration

public void EndPanel()

OnGUI(MaterialEditor, MaterialProperty[])

To define a custom shader GUI use the methods of materialEditor to render controls for the properties array.

Declaration

public override void OnGUI(MaterialEditor materialEditor, MaterialProperty[] properties)

Parameters

Type	Name	Description
MaterialEditor	materialEditor	The MaterialEditor that are calling this OnGUI (the 'owner').
MaterialProperty[]	properties	Material properties of the current selected shader.

Overrides

ShaderGUI.OnGUI(MaterialEditor, MaterialProperty[])