Component:UI TextUnlitMaterial

Component image

The UI_TextUnlitMaterial component is a material used to render text glyphs on a UIX. It does so via meshes that automatically generates UV maps that map to each character on a font map. Such as Component:Text and Component:TextRenderer.

Usage

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
`HighPriorityIntegration`	Bool	If true, integrating this asset (e.g. processing procedural assets) gets higher priority than assets with this flag off. An example is user laser procedural meshes.
`_shader`	Shader	Internal.
`FontAtlas`	ITexture2D	The font to render.
`TintColor`	ColorX	What color to tint the projected image.
`OutlineColor`	ColorX	The color of the outline around the mesh.
`BackgroundColor`	ColorX	The color of behind each text glyph
`AutoBackgroundColor`	Bool	Whether to automatically generate the background text color.
`GlyphRenderMethod`	GlyphRenderMethod	How to render each glyph or text character.
`PixelRange`	Float	Sets the distance field range in output pixels.
`FaceDilate`	Float	How fat to make the letters like bolding them.
`OutlineThickness`	Float	The thickness of the outline on text for colored outlines.
`FaceSoftness`	Float	How much blurring to do on the edges of the text.
`BlendMode`	BlendMode	How to blend this material's colors vs what it rendered on top of.
`Sidedness`	Sidedness	Render on both sides of the mesh, front, or back.
`ZWrite`	ZWrite	whether this material should respect the distance it is from the camera.
`ZTest`	ZTest	Determines whether this object should render when it is in front of or behind other objects that respect depth from the camera
`OffsetFactor`	Float	How much this material should be pushed forwards or backwards on the depth buffer, based on the polygon's slope relative to the camera (i.e. polygons parallel to the camera will not be affected by this).^[1]
`OffsetUnits`	Float	How much this material should be pushed forwards or backwards on the depth buffer (regardless of the polygon's slope relative to the camera), in units equal to the smallest possible difference for the rendering device being used.^[1]
`RenderQueue`	Int	changes at which point a material renders on the render stack
`Overlay`	Bool	Whether this material should render on top of everything
`OverlayTint`	ColorX	what to tint the entire material as.
`Rect`	Rect	See RectClip on Materials.
`RectClip`	Bool	Toggles if the material should use `Rect`
`ColorMask`	ColorMask	What colors behind the material should make it through the filter.
`StencilComparison`	StencilComparison	See Type:StencilComparison for an in depth explanation on what this does.
`StencilOperation`	StencilOperation	See Type:StencilOperation for an in depth explanation on what this does.
`StencilID`	Byte	The Stencil ID of this material. This is sometimes written to the frame buffer's Stencil mask, or used to determine whether this material should render for a particular pixel.
`StencilWriteMask`	Byte	does a Bitwise AND with this number for every pixel in the frame buffer this is rendering on top of when this object is drawn, after reading from the buffer.
`StencilReadMask`	Byte	is bitwise ANDed with the Stencil in the frame buffer before the test compares them.

Component:UI TextUnlitMaterial

Usage

Usage

Examples

See Also