Data Construction¶

Integer Vectors¶

Include @i2, @i3, @i4, @i8, @i16

These built-in functions construct integer vector types (int2, int3, int4, int8, int16).
Can only accept both constants and variables as values for its parameters, however they must be of type int.
If only one value was provided for its parameter, the function will automatically fill the remaining parameters with the provided value.

@i2, @i3, @i4, @i8, @i16 example

  @i2(1 1) | Log("i2 value")

  @i3(1 2 3) | Log("i3 value")

  @i4(1 2 3 4) | Log("i4 value")

  @i8(1) | Log("i8 value")

  @i16(1) | Log("i16 value")

Float Vectors¶

Include @f2, @f3, @f4

These built-in functions construct float vector types (float2, float3, float4).
Can only accept both constants and variables as values for its parameters, however they must be of Type::Float.
If only one value was provided for its parameter, the function will automatically fill the remaining parameters with the provided value.

@f2, @f3, @f4, @f8, @f16 example

  @f2(1 1) | Log("f2 value")

  @f3(1 2 3) | Log("f3 value")

  @f4(1 2 3 4) | Log("f4 value")

Color Vectors¶

Includes @color

Creates a RGBA color (RGBA color value represents RED, GREEN, and BLUE light sources, with an Alpha channel (opacity))
There are different formats to construct the RGBA color.
If integer constants or variables were provided as the parameters, each parameter (red, green, blue or alpha) defines the intensity of the color or alpha with a value between 0 and 255.
If float constants or variables were provided as the parameters, each parameter (red, green, blue or alpha) defines the intensity of the color or alpha with a value between 0.0 and 1.0.
If a single float or integer value was provided as the parameter, the remaining 3 will automatically be filled with the single value provided.
A hexadecimal RGB literal can also be provided as a parameter to generate the corresponding color.

Format	Example	Description
Float RGBA	`@color(1.0 0.5 0.0 1.0)`	Values between `0.0`–`1.0` for R, G, B, A
Integer RGB	`@color(255 0 128)`	Values between `0`–`255` for R, G, B; alpha defaults to 255
Hex RGB	`@color(0x008080)`	Packed RGB hex literal (`0xRRGGBB`)
Hex RGBA	`@color(0x008080ff)`	Packed RGBA hex literal (`0xRRGGBBAA`)

@color example

  @color(1.0 0.0 0.0 1.0) | Log("red color")

  @color(255 0 255) | Log("purple color")

  @color(0) | Log("black color")

  @color(0x008080ff) | Log("teal color")

@type¶

produces a Type descriptor object in Shards — basically a value that describes a type.

@type has the following parameters

Parameter	Type	Description
Type (required)	`Type` (enum or descriptor)	The base type to describe. This can be a an enum like `Type::Int`, a container type like `[Type::Int]`, or a composite like a table `{ fieldName: Type::X }`, or a shard like `GFX.BuiltinMesh`.
Variable (optional)	`bool`	Marks the type as variable. Mainly used internally.
InputType (optional)	`bool`	If a shard was provided for the `Type` parameter, `@type` will generate the output of the provided shard. If `InputType` was set to `true` it will generate the type of the input of the provided shard instead.
ObjectVendor / ObjectTypeId / ObjectName	`string`	These fields are used when describing a custom object type, where the runtime finds the specified custom object.

@type example

  Sequence(Name: int-seq Type: @type([Type::Int])) ;; Creates a sequence with the specified type

  {name: "hello" id: @i16(0)} >= temp-table

  temp-table
  Expect(Type: @type({name: Type::String id: Type::Int16})) ;; Verifies the type of the table

  @mesh(foo)
  Const(foo) | Expect(@type(Type::Object ObjectName: "Mesh")) | Log ;; Verifies the type of the Object

  @type(GFX.BuiltinMesh InputType: true) ;; Generates the type of the input of GFX.BuiltinMesh