Enumerationmigueldeicaza.swiftgodot 0.45.0SwiftGodot
AlphaCutMode
SpriteBase3D.swift:41enum AlphaCutModeCases
case disabledThis mode performs standard alpha blending. It can display translucent areas, but transparency sorting issues may be visible when multiple transparent materials are overlapping.
case discardThis mode only allows fully transparent or fully opaque pixels. Harsh edges will be visible unless some form of screen-space antialiasing is enabled (see
ProjectSettings/rendering/antiAliasing/quality/screenSpaceAa). 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 alpha testing or 1-bit transparency.case opaquePrepassThis mode draws fully opaque pixels in the depth prepass. This is slower than .alphaCutDisabled or .alphaCutDiscard, but it allows displaying translucent areas and smooth edges while using proper sorting.
case hashThis mode draws cuts off all values below a spatially-deterministic threshold, the rest will remain opaque.
Other members in extension
View members
Hide members
This section is hidden by default because it contains too many (24) members.
Types
Type members
Instance members
var alphaAntialiasingEdge: DoubleThreshold at which antialiasing will be applied on the alpha channel.
var alphaAntialiasingMode: BaseMaterial3D.AlphaAntiAliasingThe type of alpha antialiasing to apply. See
BaseMaterial3D.AlphaAntiAliasing.var alphaCut: SpriteBase3D.AlphaCutModeThe alpha cutting mode to use for the sprite. See
AlphaCutModefor possible values.var alphaHashScale: DoubleThe hashing scale for Alpha Hash. Recommended values between
0and2.var alphaScissorThreshold: DoubleThreshold at which the alpha scissor will discard values.
var axis: Vector3.AxisThe direction in which the front of the texture faces.
var billboard: BaseMaterial3D.BillboardModeThe billboard mode to use for the sprite. See
BaseMaterial3D.BillboardModefor possible values.var centered: BoolIf
true, texture will be centered.var doubleSided: BoolIf
true, texture can be seen from the back as well, iffalse, it is invisible when looking at it from behind.var fixedSize: BoolIf
true, the label is rendered at the same size regardless of distance.var flipH: BoolIf
true, texture is flipped horizontally.var flipV: BoolIf
true, texture is flipped vertically.var modulate: ColorA color value used to multiply the texture’s colors. Can be used for mood-coloring or to simulate the color of light.
var noDepthTest: BoolIf
true, depth testing is disabled and the object will be drawn in render order.var offset: Vector2The texture’s drawing offset.
var pixelSize: DoubleThe size of one pixel’s width on the sprite to scale it in 3D.
var renderPriority: Int32Sets the render priority for the sprite. Higher priority objects will be sorted in front of lower priority objects.
var shaded: BoolIf
true, theLight3Din theEnvironmenthas effects on the sprite.var textureFilter: BaseMaterial3D.TextureFilterFilter flags for the texture. See
BaseMaterial3D.TextureFilterfor options.var transparent: BoolIf
true, the texture’s transparency and the opacity are used to make those parts of the sprite invisible.func generateTriangleMesh() -> TriangleMesh? Returns a
TriangleMeshwith the sprite’s vertices following its current configuration (such as itsaxisandpixelSize).func getItemRect() -> Rect2 Returns the rectangle representing this sprite.
Citizens in SwiftGodot
Conformances
protocol CaseIterableA type that provides a collection of all of its values.
protocol CustomDebugStringConvertibleA type with a customized textual representation suitable for debugging purposes.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol RawRepresentable<RawValue>A type that can be converted to and from an associated raw value.
Type members
Instance members
var debugDescription: StringA textual representation of this instance, suitable for debugging
Type features
static func != (lhs: Self, rhs: Self) -> Bool Returns a Boolean value indicating whether two values are not equal.