SpriteBase3D

Documentation

Overview

Package SpriteBase3D provides methods for working with SpriteBase3D object instances.

Index

• type Advanced
• type AlphaCutMode
• type Any
• type DrawFlags
• type Instance
  • func New() Instance
  • func (self Instance) AlphaAntialiasingEdge() Float.X
  • func (self Instance) AlphaAntialiasingMode() gdclass.BaseMaterial3DAlphaAntiAliasing
  • func (self Instance) AlphaCut() gdclass.SpriteBase3DAlphaCutMode
  • func (self Instance) AlphaHashScale() Float.X
  • func (self Instance) AlphaScissorThreshold() Float.X
  • func (self Instance) AsGeometryInstance3D() GeometryInstance3D.Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsSpriteBase3D() Instance
  • func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance
  • func (self Instance) Axis() gd.Vector3Axis
  • func (self Instance) Billboard() gdclass.BaseMaterial3DBillboardMode
  • func (self Instance) Centered() bool
  • func (self Instance) DoubleSided() bool
  • func (self Instance) FixedSize() bool
  • func (self Instance) FlipH() bool
  • func (self Instance) FlipV() bool
  • func (self Instance) GenerateTriangleMesh() [1]gdclass.TriangleMesh
  • func (self Instance) GetItemRect() Rect2.PositionSize
  • func (self Instance) Modulate() Color.RGBA
  • func (self Instance) NoDepthTest() bool
  • func (self Instance) Offset() Vector2.XY
  • func (self Instance) PixelSize() Float.X
  • func (self Instance) RenderPriority() int
  • func (self Instance) SetAlphaAntialiasingEdge(value Float.X)
  • func (self Instance) SetAlphaAntialiasingMode(value gdclass.BaseMaterial3DAlphaAntiAliasing)
  • func (self Instance) SetAlphaCut(value gdclass.SpriteBase3DAlphaCutMode)
  • func (self Instance) SetAlphaHashScale(value Float.X)
  • func (self Instance) SetAlphaScissorThreshold(value Float.X)
  • func (self Instance) SetAxis(value gd.Vector3Axis)
  • func (self Instance) SetBillboard(value gdclass.BaseMaterial3DBillboardMode)
  • func (self Instance) SetCentered(value bool)
  • func (self Instance) SetDoubleSided(value bool)
  • func (self Instance) SetFixedSize(value bool)
  • func (self Instance) SetFlipH(value bool)
  • func (self Instance) SetFlipV(value bool)
  • func (self Instance) SetModulate(value Color.RGBA)
  • func (self Instance) SetNoDepthTest(value bool)
  • func (self Instance) SetOffset(value Vector2.XY)
  • func (self Instance) SetPixelSize(value Float.X)
  • func (self Instance) SetRenderPriority(value int)
  • func (self Instance) SetShaded(value bool)
  • func (self Instance) SetTextureFilter(value gdclass.BaseMaterial3DTextureFilter)
  • func (self Instance) SetTransparent(value bool)
  • func (self Instance) Shaded() bool
  • func (self Instance) TextureFilter() gdclass.BaseMaterial3DTextureFilter
  • func (self Instance) Transparent() bool
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value

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.SpriteBase3DAlphaCutMode //gd:SpriteBase3D.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.*/
	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]). On the bright side, this mode doesn't suffer from transparency sorting issues when multiple transparent materials are overlapping. This mode is also known as [i]alpha testing[/i] or [i]1-bit transparency[/i].*/
	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.*/
	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
	AsSpriteBase3D() Instance
}

type DrawFlags

type DrawFlags = gdclass.SpriteBase3DDrawFlags //gd:SpriteBase3D.DrawFlags

const (
	/*If set, the texture's transparency and the opacity are used to make those parts of the sprite invisible.*/
	FlagTransparent DrawFlags = 0
	/*If set, lights in the environment affect the sprite.*/
	FlagShaded DrawFlags = 1
	/*If set, texture can be seen from the back as well. If not, the texture is invisible when looking at it from behind.*/
	FlagDoubleSided DrawFlags = 2
	/*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 = 3
	/*Label is scaled by depth so that it always appears the same size on screen.*/
	FlagFixedSize DrawFlags = 4
	/*Represents the size of the [enum DrawFlags] enum.*/
	FlagMax DrawFlags = 5
)

type Instance

type Instance [1]gdclass.SpriteBase3D

A node that displays 2D texture information in a 3D environment. See also [Sprite3D] where many other properties are defined.

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.SpriteBase3DAlphaCutMode

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) 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) AsSpriteBase3D

func (self Instance) AsSpriteBase3D() Instance

func (Instance) AsVisualInstance3D

func (self Instance) AsVisualInstance3D() VisualInstance3D.Instance

func (Instance) Axis

func (self Instance) Axis() gd.Vector3Axis

func (Instance) Billboard

func (self Instance) Billboard() gdclass.BaseMaterial3DBillboardMode

func (Instance) Centered

func (self Instance) Centered() bool

func (Instance) DoubleSided

func (self Instance) DoubleSided() bool

func (Instance) FixedSize

func (self Instance) FixedSize() bool

func (Instance) FlipH

func (self Instance) FlipH() bool

func (Instance) FlipV

func (self Instance) FlipV() bool

func (Instance) GenerateTriangleMesh

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

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

func (Instance) GetItemRect

func (self Instance) GetItemRect() Rect2.PositionSize

Returns the rectangle representing this sprite.

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) 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.SpriteBase3DAlphaCutMode)

func (Instance) SetAlphaHashScale

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

func (Instance) SetAlphaScissorThreshold

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

func (Instance) SetAxis

func (self Instance) SetAxis(value gd.Vector3Axis)

func (Instance) SetBillboard

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

func (Instance) SetCentered

func (self Instance) SetCentered(value bool)

func (Instance) SetDoubleSided

func (self Instance) SetDoubleSided(value bool)

func (Instance) SetFixedSize

func (self Instance) SetFixedSize(value bool)

func (Instance) SetFlipH

func (self Instance) SetFlipH(value bool)

func (Instance) SetFlipV

func (self Instance) SetFlipV(value bool)

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) 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) SetTextureFilter

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

func (Instance) SetTransparent

func (self Instance) SetTransparent(value bool)

func (Instance) Shaded

func (self Instance) Shaded() bool

func (Instance) TextureFilter

func (self Instance) TextureFilter() gdclass.BaseMaterial3DTextureFilter

func (Instance) Transparent

func (self Instance) Transparent() bool

func (*Instance) UnsafePointer

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

func (Instance) Virtual

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