scala-native-gdextension
API
Generated with
scala-native-gdextension/gdext/gdext.classes/SurfaceTool

SurfaceTool

gdext.classes.SurfaceTool
See theSurfaceTool companion object
abstract class SurfaceTool extends RefCounted

Generated wrapper for Godot's SurfaceTool, extends RefCounted.

Attributes

Companion
object
Graph
Supertypes
class RefCounted
class Object
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

final def addIndex(index: Long): Unit

SurfaceTool.add_index

SurfaceTool.add_index

Attributes

final def addVertex(vertex: Vector3): Unit

SurfaceTool.add_vertex

SurfaceTool.add_vertex

Attributes

final def appendFrom(existing: Mesh, surface: Long, transform: Transform3D): Unit

SurfaceTool.append_from

SurfaceTool.append_from

Attributes

final def begin(primitive: Long): Unit

SurfaceTool.begin

SurfaceTool.begin

Attributes

final def clear(): Unit

SurfaceTool.clear

SurfaceTool.clear

Attributes

final def commit(existing: ArrayMesh, flags: Long): ArrayMesh

SurfaceTool.commit. Returns an owned reference: release it with unref() or inside Gd.scoped.

SurfaceTool.commit. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def createFrom(existing: Mesh, surface: Long): Unit

SurfaceTool.create_from

SurfaceTool.create_from

Attributes

final def createFromBlendShape(existing: Mesh, surface: Long, blend_shape: String): Unit

SurfaceTool.create_from_blend_shape

SurfaceTool.create_from_blend_shape

Attributes

final def deindex(): Unit

SurfaceTool.deindex

SurfaceTool.deindex

Attributes

final def generateNormals(flip: Boolean): Unit

SurfaceTool.generate_normals

SurfaceTool.generate_normals

Attributes

final def generateTangents(): Unit

SurfaceTool.generate_tangents

SurfaceTool.generate_tangents

Attributes

final def getAabb(): AABB

SurfaceTool.get_aabb

SurfaceTool.get_aabb

Attributes

final def getCustomFormat(channel_index: Long): Long

SurfaceTool.get_custom_format

SurfaceTool.get_custom_format

Attributes

final def getPrimitiveType(): Long

SurfaceTool.get_primitive_type

SurfaceTool.get_primitive_type

Attributes

final def getSkinWeightCount(): Long

SurfaceTool.get_skin_weight_count

SurfaceTool.get_skin_weight_count

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def index(): Unit

SurfaceTool.index

SurfaceTool.index

Attributes

final def optimizeIndicesForCache(): Unit

SurfaceTool.optimize_indices_for_cache

SurfaceTool.optimize_indices_for_cache

Attributes

final def setColor(color: Color): Unit

SurfaceTool.set_color

SurfaceTool.set_color

Attributes

final def setCustom(channel_index: Long, custom_color: Color): Unit

SurfaceTool.set_custom

SurfaceTool.set_custom

Attributes

final def setCustomFormat(channel_index: Long, format: Long): Unit

SurfaceTool.set_custom_format

SurfaceTool.set_custom_format

Attributes

final def setMaterial(material: Material): Unit

SurfaceTool.set_material

SurfaceTool.set_material

Attributes

final def setNormal(normal: Vector3): Unit

SurfaceTool.set_normal

SurfaceTool.set_normal

Attributes

final def setSkinWeightCount(count: Long): Unit

SurfaceTool.set_skin_weight_count

SurfaceTool.set_skin_weight_count

Attributes

final def setSmoothGroup(index: Long): Unit

SurfaceTool.set_smooth_group

SurfaceTool.set_smooth_group

Attributes

final def setTangent(tangent: Plane): Unit

SurfaceTool.set_tangent

SurfaceTool.set_tangent

Attributes

final def setUv(uv: Vector2): Unit

SurfaceTool.set_uv

SurfaceTool.set_uv

Attributes

final def setUv2(uv2: Vector2): Unit

SurfaceTool.set_uv2

SurfaceTool.set_uv2

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object
final def getReferenceCount(): Long

RefCounted.get_reference_count

RefCounted.get_reference_count

Attributes

Inherited from:
RefCounted
final def getTranslationDomain(): StringName

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def initRef(): Boolean

RefCounted.init_ref

RefCounted.init_ref

Attributes

Inherited from:
RefCounted
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def reference(): Boolean

RefCounted.reference

RefCounted.reference

Attributes

Inherited from:
RefCounted
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def unreference(): Boolean

RefCounted.unreference

RefCounted.unreference

Attributes

Inherited from:
RefCounted
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass
Generated with