-
Notifications
You must be signed in to change notification settings - Fork 0
CanvasLayer
Home | API by Category | Complete API Index | API Compatibility
| Field | Value |
|---|---|
| Full name | Electron2D.CanvasLayer |
| Namespace | Electron2D |
| Kind | class |
| Category | Rendering |
Provides an Electron2D node that renders 2D descendants on an independent canvas layer.
public class Electron2D.CanvasLayer : Electron2D.NodeProfile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: CanvasLayer
Layer, visibility and transform baseline for independent 2D canvas ordering.
Descendant Electron2D.CanvasItem nodes are submitted with this layer's
numeric draw layer. Lower layers are drawn before higher layers, regardless
of descendant ZIndex values.
This type is not synchronized. Create and mutate layers on the main scene thread.
This type is available since Electron2D 0.1.0 Preview.
| Member | Kind | Summary |
|---|---|---|
Layer |
Property | Gets or sets the numeric draw layer. |
Offset |
Property | Gets or sets the layer offset. |
Rotation |
Property | Gets or sets the layer rotation in radians. |
RotationDegrees |
Property | Gets or sets the layer rotation in degrees. |
Scale |
Property | Gets or sets the layer scale. |
Transform |
Property | Gets or sets the layer transform. |
Visible |
Property | Gets or sets whether this canvas layer is visible. |
Electron2D.CanvasLayer() |
Constructor | Initializes a new instance of the CanvasLayer type. |
GetFinalTransform() |
Method | Gets the transform applied to descendant canvas items during submission. |
Hide() |
Method | Hides this canvas layer and its submitted descendants. |
Show() |
Method | Shows this canvas layer. |
Kind: Property
public System.Int32 Layer { get; set; }Gets or sets the numeric draw layer.
The default value is 1. Canvas items outside any
CanvasLayer are submitted to layer 0.
The current layer value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer
Kind: Property
public Electron2D.Vector2 Offset { get; set; }Gets or sets the layer offset.
This property follows the validation and lifetime rules of its declaring type.
The current offset value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer
Kind: Property
public System.Single Rotation { get; set; }Gets or sets the layer rotation in radians.
This property follows the validation and lifetime rules of its declaring type.
The current rotation value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer.RotationDegrees
Kind: Property
public System.Single RotationDegrees { get; set; }Gets or sets the layer rotation in degrees.
This property follows the validation and lifetime rules of its declaring type.
The current rotation degrees value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer.Rotation
Kind: Property
public Electron2D.Vector2 Scale { get; set; }Gets or sets the layer scale.
This property follows the validation and lifetime rules of its declaring type.
The current scale value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer
Kind: Property
public Electron2D.Transform2D Transform { get; set; }Gets or sets the layer transform.
The setter decomposes offset, rotation and scale for transforms without skew. Skew is outside the Electron2D 0.1.0 Preview subset.
The current transform value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer
Kind: Property
public System.Boolean Visible { get; set; }Gets or sets whether this canvas layer is visible.
This property follows the validation and lifetime rules of its declaring type.
The current visible value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer
Kind: Constructor
public Electron2D.CanvasLayer()Initializes a new instance of the CanvasLayer type.
The new instance follows the lifetime and validation rules of its declaring type.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer
Kind: Method
public Electron2D.Transform2D GetFinalTransform()()Gets the transform applied to descendant canvas items during submission.
This method follows the validation and lifetime rules of its declaring type.
The layer transform for Electron2D 0.1.0 Preview.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer
Kind: Method
public System.Void Hide()()Hides this canvas layer and its submitted descendants.
This method follows the validation and lifetime rules of its declaring type.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer.Show
Kind: Method
public System.Void Show()()Shows this canvas layer.
This method follows the validation and lifetime rules of its declaring type.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CanvasLayer.Hide
Electron2D 0.1.0 Preview API reference. Generated from 175 public runtime types.