Label3D

package
v0.0.0-...-c909628 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 13, 2025 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

Package Label3D provides methods for working with Label3D object instances.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type AlphaCutMode 

type AlphaCutMode = gdclass.Label3DAlphaCutMode //gd:Label3D.AlphaCutMode

const (
	/*This mode performs standard alpha blending. It can display translucent areas, but transparency sorting issues may be visible when multiple transparent materials are overlapping. [member GeometryInstance3D.cast_shadow] has no effect when this transparency mode is used; the [Label3D] will never cast shadows.*/
	AlphaCutDisabled AlphaCutMode = 0
	/*This mode only allows fully transparent or fully opaque pixels. Harsh edges will be visible unless some form of screen-space antialiasing is enabled (see [member ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa]). This mode is also known as [i]alpha testing[/i] or [i]1-bit transparency[/i].
	  [b]Note:[/b] This mode might have issues with anti-aliased fonts and outlines, try adjusting [member alpha_scissor_threshold] or using MSDF font.
	  [b]Note:[/b] When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.*/
	AlphaCutDiscard AlphaCutMode = 1
	/*This mode draws fully opaque pixels in the depth prepass. This is slower than [constant ALPHA_CUT_DISABLED] or [constant ALPHA_CUT_DISCARD], but it allows displaying translucent areas and smooth edges while using proper sorting.
	  [b]Note:[/b] When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.*/
	AlphaCutOpaquePrepass AlphaCutMode = 2
	/*This mode draws cuts off all values below a spatially-deterministic threshold, the rest will remain opaque.*/
	AlphaCutHash AlphaCutMode = 3
)

type Any 

type Any interface {
	gd.IsClass
	AsLabel3D() Instance
}

type DrawFlags 

type DrawFlags = gdclass.Label3DDrawFlags //gd:Label3D.DrawFlags

const (
	/*If set, lights in the environment affect the label.*/
	FlagShaded DrawFlags = 0
	/*If set, text can be seen from the back as well. If not, the text is invisible when looking at it from behind.*/
	FlagDoubleSided DrawFlags = 1
	/*Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.*/
	FlagDisableDepthTest DrawFlags = 2
	/*Label is scaled by depth so that it always appears the same size on screen.*/
	FlagFixedSize DrawFlags = 3
	/*Represents the size of the [enum DrawFlags] enum.*/
	FlagMax DrawFlags = 4
)

type HorizontalAlignment 

type HorizontalAlignment int
const (
	/*Horizontal left alignment, usually for text-derived classes.*/
	HorizontalAlignmentLeft HorizontalAlignment = 0
	/*Horizontal center alignment, usually for text-derived classes.*/
	HorizontalAlignmentCenter HorizontalAlignment = 1
	/*Horizontal right alignment, usually for text-derived classes.*/
	HorizontalAlignmentRight HorizontalAlignment = 2
	/*Expand row to fit width, usually for text-derived classes.*/
	HorizontalAlignmentFill HorizontalAlignment = 3
)

type Instance 

type Instance [1]gdclass.Label3D

A node for displaying plain text in 3D space. By adjusting various properties of this node, you can configure things such as the text's appearance and whether it always faces the camera. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) AlphaAntialiasingEdge 

func (self Instance) AlphaAntialiasingEdge() Float.X

func (Instance) AlphaAntialiasingMode 

func (self Instance) AlphaAntialiasingMode() gdclass.BaseMaterial3DAlphaAntiAliasing

func (Instance) AlphaCut 

func (self Instance) AlphaCut() gdclass.Label3DAlphaCutMode

func (Instance) AlphaHashScale 

func (self Instance) AlphaHashScale() Float.X

func (Instance) AlphaScissorThreshold 

func (self Instance) AlphaScissorThreshold() Float.X

func (Instance) AsGeometryInstance3D 

func (self Instance) AsGeometryInstance3D() GeometryInstance3D.Instance

func (Instance) AsLabel3D 

func (self Instance) AsLabel3D() Instance

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D 

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsVisualInstance3D 

func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance

func (Instance) AutowrapMode 

func (self Instance) AutowrapMode() gdclass.TextServerAutowrapMode

func (Instance) Billboard 

func (self Instance) Billboard() gdclass.BaseMaterial3DBillboardMode

func (Instance) DoubleSided 

func (self Instance) DoubleSided() bool

func (Instance) FixedSize 

func (self Instance) FixedSize() bool

func (Instance) Font 

func (self Instance) Font() [1]gdclass.Font

func (Instance) FontSize 

func (self Instance) FontSize() int

func (Instance) GenerateTriangleMesh 

func (self Instance) GenerateTriangleMesh() [1]gdclass.TriangleMesh

Returns a [TriangleMesh] with the label's vertices following its current configuration (such as its [member pixel_size]).

func (Instance) HorizontalAlignment 

func (self Instance) HorizontalAlignment() HorizontalAlignment

func (Instance) JustificationFlags 

func (self Instance) JustificationFlags() gdclass.TextServerJustificationFlag

func (Instance) Language 

func (self Instance) Language() string

func (Instance) LineSpacing 

func (self Instance) LineSpacing() Float.X

func (Instance) Modulate 

func (self Instance) Modulate() Color.RGBA

func (Instance) NoDepthTest 

func (self Instance) NoDepthTest() bool

func (Instance) Offset 

func (self Instance) Offset() Vector2.XY

func (Instance) OutlineModulate 

func (self Instance) OutlineModulate() Color.RGBA

func (Instance) OutlineRenderPriority 

func (self Instance) OutlineRenderPriority() int

func (Instance) OutlineSize 

func (self Instance) OutlineSize() int

func (Instance) PixelSize 

func (self Instance) PixelSize() Float.X

func (Instance) RenderPriority 

func (self Instance) RenderPriority() int

func (Instance) SetAlphaAntialiasingEdge 

func (self Instance) SetAlphaAntialiasingEdge(value Float.X)

func (Instance) SetAlphaAntialiasingMode 

func (self Instance) SetAlphaAntialiasingMode(value gdclass.BaseMaterial3DAlphaAntiAliasing)

func (Instance) SetAlphaCut 

func (self Instance) SetAlphaCut(value gdclass.Label3DAlphaCutMode)

func (Instance) SetAlphaHashScale 

func (self Instance) SetAlphaHashScale(value Float.X)

func (Instance) SetAlphaScissorThreshold 

func (self Instance) SetAlphaScissorThreshold(value Float.X)

func (Instance) SetAutowrapMode 

func (self Instance) SetAutowrapMode(value gdclass.TextServerAutowrapMode)

func (Instance) SetBillboard 

func (self Instance) SetBillboard(value gdclass.BaseMaterial3DBillboardMode)

func (Instance) SetDoubleSided 

func (self Instance) SetDoubleSided(value bool)

func (Instance) SetFixedSize 

func (self Instance) SetFixedSize(value bool)

func (Instance) SetFont 

func (self Instance) SetFont(value [1]gdclass.Font)

func (Instance) SetFontSize 

func (self Instance) SetFontSize(value int)

func (Instance) SetHorizontalAlignment 

func (self Instance) SetHorizontalAlignment(value HorizontalAlignment)

func (Instance) SetJustificationFlags 

func (self Instance) SetJustificationFlags(value gdclass.TextServerJustificationFlag)

func (Instance) SetLanguage 

func (self Instance) SetLanguage(value string)

func (Instance) SetLineSpacing 

func (self Instance) SetLineSpacing(value Float.X)

func (Instance) SetModulate 

func (self Instance) SetModulate(value Color.RGBA)

func (Instance) SetNoDepthTest 

func (self Instance) SetNoDepthTest(value bool)

func (Instance) SetOffset 

func (self Instance) SetOffset(value Vector2.XY)

func (Instance) SetOutlineModulate 

func (self Instance) SetOutlineModulate(value Color.RGBA)

func (Instance) SetOutlineRenderPriority 

func (self Instance) SetOutlineRenderPriority(value int)

func (Instance) SetOutlineSize 

func (self Instance) SetOutlineSize(value int)

func (Instance) SetPixelSize 

func (self Instance) SetPixelSize(value Float.X)

func (Instance) SetRenderPriority 

func (self Instance) SetRenderPriority(value int)

func (Instance) SetShaded 

func (self Instance) SetShaded(value bool)

func (Instance) SetStructuredTextBidiOverride 

func (self Instance) SetStructuredTextBidiOverride(value gdclass.TextServerStructuredTextParser)

func (Instance) SetStructuredTextBidiOverrideOptions 

func (self Instance) SetStructuredTextBidiOverrideOptions(value []any)

func (Instance) SetText 

func (self Instance) SetText(value string)

func (Instance) SetTextDirection 

func (self Instance) SetTextDirection(value gdclass.TextServerDirection)

func (Instance) SetTextureFilter 

func (self Instance) SetTextureFilter(value gdclass.BaseMaterial3DTextureFilter)

func (Instance) SetUppercase 

func (self Instance) SetUppercase(value bool)

func (Instance) SetVerticalAlignment 

func (self Instance) SetVerticalAlignment(value VerticalAlignment)

func (Instance) SetWidth 

func (self Instance) SetWidth(value Float.X)

func (Instance) Shaded 

func (self Instance) Shaded() bool

func (Instance) StructuredTextBidiOverride 

func (self Instance) StructuredTextBidiOverride() gdclass.TextServerStructuredTextParser

func (Instance) StructuredTextBidiOverrideOptions 

func (self Instance) StructuredTextBidiOverrideOptions() []any

func (Instance) Text 

func (self Instance) Text() string

func (Instance) TextDirection 

func (self Instance) TextDirection() gdclass.TextServerDirection

func (Instance) TextureFilter 

func (self Instance) TextureFilter() gdclass.BaseMaterial3DTextureFilter

func (*Instance) UnsafePointer 

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Uppercase 

func (self Instance) Uppercase() bool

func (Instance) VerticalAlignment 

func (self Instance) VerticalAlignment() VerticalAlignment

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

func (Instance) Width 

func (self Instance) Width() Float.X

type VerticalAlignment 

type VerticalAlignment int
const (
	/*Vertical top alignment, usually for text-derived classes.*/
	VerticalAlignmentTop VerticalAlignment = 0
	/*Vertical center alignment, usually for text-derived classes.*/
	VerticalAlignmentCenter VerticalAlignment = 1
	/*Vertical bottom alignment, usually for text-derived classes.*/
	VerticalAlignmentBottom VerticalAlignment = 2
	/*Expand rows to fit height, usually for text-derived classes.*/
	VerticalAlignmentFill VerticalAlignment = 3
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.