Contents

Enum Reference
Updated 152 Days AgoPublic

Enum
ActionExecuteMode
ActionState
AnimationBlendMode
AnimationBlendType
AnimationPlayMode
ArrowHeadType
AtomFilter
AudioCueImport
AudioFileLoadType
AudioLatency
AudioMixTypes
Authority
AuthorityMode
AxisDirection
BasicNetType
BasisType
BlendEquation
BlendFactor
BlendMode
BoundType
Buttons
CameraDragMode
CapsuleScalingMode
CastFilterState
CellIndexType
CogPathPreference
ColliderType
CollisionFilterBlockType
CollisionFilterCollisionFlags
CollisionType
ConflictAction
ConnectResponse
ConnectResponseMode
ConstraintPositionCorrection
ControlMode
ConvergenceState
CullMode
Cursor
CurveType
DefaultAddOnFilters
DepthMode
DetectionMode
DisconnectReason
DockArea
Ease
EditorMode
Enum
eUpdateTransformState
FalloffCurveType
Filter
FlickedStick
FragmentCountFilter
FragmentFilter
GeometryValue
GizmoBasis
GizmoDragMode
GizmoGrab
GizmoGrabMode
GizmoPivot
GizmoSnapMode
GranularSynthWindows
GraphicalSortMethod
HeightTextureSelect
HeightTool
HorizontalAlignment
ImageImport
ImportFrames
ImportMode
IncludeMode
IndicatorSide
InputDevice
InternalKeyState
InternetProtocol
JointFrameOfReference
JointToolTypes
JointTypes
Keys
KeyState
LauncherAutoRunMode
LinkState
LinkStatus
Location
LoopingMode
MeshEmitMode
MeshImport
Mode2DStates
MouseButtons
MultiConvexMeshAutoComputeMethod
MultiConvexMeshAutoComputeMode
MultiConvexMeshDrawMode
MultiConvexMeshSnappingMode
NetRefreshResult
NetRole
NetUserAddResponse
Network
ObjectIndex
OrientationBases
PerspectiveMode
PhysicsContactTangentTypes
PhysicsEffectEndCondition
PhysicsEffectInterpolationType
PhysicsEffectType
PhysicsImport
PhysicsIslandPreProcessingMode
PhysicsIslandType
PhysicsMeshType
PhysicsSolverPositionCorrection
PhysicsSolverSubType
PhysicsSolverType
Placement
PlayGameOptions
PrimitiveType
Receipt
ReceiveState
ReliabilityMode
ReplicationPhase
RigidBodyDynamicState
RouteMode
ScaleConversion
SendsEvents
SerializationMode
ShadowResolution
SoundPlayMode
SoundSelectMode
SplineAnimatorMode
SplineType
SpringDebugDrawMode
SpringDebugDrawType
SpringSortOrder
SpringSubTools
SpriteFill
SpriteGeometryMode
SpriteOrigin
SpriteParticleAnimationMode
SpriteParticleGeometryMode
SpriteParticleSortMode
SpriteSampling
StencilMode
StencilOp
StoreResult
StreamOrigin
StreamType
SynthWaveType
SystemSpace
TabWidth
TcpSocketBind
TextAlign
TextureAddressing
TextureAnisotropy
TextureCompareFunc
TextureCompareMode
TextureCompression
TextureFace
TextureFiltering
TextureFormat
TextureMipMapping
TextureType
TileEditor2DSubToolType
TimeDisplay
TimeMode
ToolTipColorScheme
TrackType
TransferMode
TransmissionDirection
TransportProtocol
UiDockMode
UiFocusDirection
UiHighlightColorMode
UiHighlightColorOp
UiHighlightMouseMode
UiHorizontalAlignment
UiScrollBarAxis
UiSizePolicy
UiStackLayoutDirection
UiVerticalAlignment
UpdateMode
UserConnectResponse
Verbosity
VertexElementType
VertexSemantic
VerticalAlignment
ViewportScaling
WebBrowserModifiers
WindowState
WindowStyleFlags

ActionExecuteMode
EnumValueDescription
FrameUpdate
LogicUpdate

ActionState
EnumValueDescription
Completed
Running

AnimationBlendMode
EnumValueDescription
Auto
Manual

AnimationBlendType
EnumValueDescription
Normalized
Standard

AnimationPlayMode
EnumValueDescription
Loop
Pingpong
PlayOnce

ArrowHeadType
EnumValueDescription
Arrow
Cube

AtomFilter
EnumValueDescription
AngularAxis
LinearAxis

AudioCueImport
EnumValueDescription
Grouped
None
PerSound

AudioFileLoadType

The choices for how to load and play an audio file.

EnumValueDescription
AutoThis will choose whether to stream a file depending on its length. Files longer than 30 seconds will be streamed from memory, and those longer than 1 minute will be streamed from file.
StreamFromFileThe audio data will be read from the file and decompressed as it plays.
StreamFromMemoryThe compressed audio data will be read into memory when the Sound resource is loaded and will be decompressed as it plays.
UncompressedThe audio data will be decompressed and held in memory when the Sound resource is loaded.

AudioLatency

The latency setting used by the audio system.

EnumValueDescription
HighAudio will have a higher latency. This can fix some audio problems in some cases.
LowThe default setting, where audio will have a low amount of latency.

AudioMixTypes

The possible settings for the number of channels used by the audio system when creating audio.

EnumValueDescription
AutoDetectThe audio system will match its channels to the default output device.
FiveOneAudio will be produced using a typical 5.1 speaker configuration.
MonoAudio will be produced using only a single channel.
QuadAudio will be produced using two left channels and two right channels.
SevenOneAudio will be produced using a typical 7.1 speaker configuration.
StereoAudio will be produced using two channels, one for the left speaker and one for the right.

Authority
EnumValueDescription
Client
Server

AuthorityMode
EnumValueDescription
Dynamic
Fixed

AxisDirection

Defines a primary direction for an axis.

EnumValueDescription
X
Y
Z

BasicNetType

Use Archetype "ResourceId:Name" String as ReplicaType? Otherwise we will use ResourceId u64 as ReplicaType (much more efficient). This impacts bandwidth performance when first spawning/cloning new NetObject types to remote peers.

EnumValueDescription
Boolean
Boolean2
Boolean3
Boolean4
Byte
DoubleInteger
DoubleReal
Integer
Integer2
Integer3
Integer4
Other
Quaternion
Real
Real2
Real2x2
Real3
Real3x3
Real4
Real4x4
String

BasisType
EnumValueDescription
NegativeX
NegativeY
NegativeZ
PositiveX
PositiveY
PositiveZ

BlendEquation

How pixel values (source) are combined with the active render target's values (destination).

EnumValueDescription
AddSource is added to destination.
MaxThe maximum value between source and destination is kept.
MinThe minimum value between source and destination is kept.
ReverseSubtractDestination is subtracted from source.
SubtractSource is subtracted from destination.

BlendFactor

Values that can be multiplied with the operands used in the blend equation.

EnumValueDescription
DestAlphaThe alpha channel of the destination value.
DestColorThe RGB of the destination value.
InvDestAlphaOne minus the alpha channel of the destination value.
InvDestColorOne minus the RGB of the destination value.
InvSourceAlphaOne minus the alpha channel of the source value.
InvSourceColorOne minus the RGB of the source value.
OneMultiplied by one, operand is unchanged.
SourceAlphaThe alpha channel of the source value.
SourceAlphaSaturateMinimum of source alpha and one minus destination alpha.
SourceColorThe RGB of the source value.
Zero

BlendMode

If blend equations are applied when writing to a render target.

EnumValueDescription
DisabledBlending is not used.
EnabledBlending is used, color and alpha use the same equations.
SeparateBlending is used, color and alpha use separate equations.

BoundType
EnumValueDescription
PrismJoint
PrismJoint2d
RevJoint
RevJoint2d

Buttons
EnumValueDescription
A
AnyButton
B
Back
DpadDown
DpadDownFiltered
DpadLeft
DpadLeftFiltered
DpadRight
DpadRightFiltered
DpadUp
DpadUpFiltered
LeftShoulder
LeftThumb
RightShoulder
RightThumb
Start
StickDown
StickLeft
StickRight
StickUp
X
Y

CameraDragMode
EnumValueDescription
NotActive
Pan
Rotation
Zoom

CapsuleScalingMode

How should a capsule collider respond to non-uniform scale?

EnumValueDescription
PreserveHeightScale applies to the height of the cylinder.
PreserveScaleScale applies to the total size of the capsule.

CastFilterState

Controls custom cast filtering via the CastFilterEvent . Allows custom filter logic per object.

EnumValueDescription
AcceptAlways accept this object for testing.
DefaultBehaviorRun the rest of the filtering logic on the cast filter.
RejectAlways reject this object for testing.

CellIndexType
EnumValueDescription
Absoulte
Local

CogPathPreference
EnumValueDescription
Absolute
CogRelative
SpaceRelative

ColliderType

All possible collider types. Needed mostly for collision detection. The order is somewhat important as collision detection currently assumes that all simple shapes (primitive types) are before the complex shapes.

EnumValueDescription
cBox
cCapsule
cConvexMesh
cCylinder
cEllipsoid
cHeightMap
cInvalid
cMesh
cMultiConvexMesh
cSize
cSphere

CollisionFilterBlockType

What kind of filter block this is. These blocks are used to send out/override collision group events of certain types (collision started, etc...)

EnumValueDescription
CollisionEndedBlock
CollisionPersistedBlock
CollisionStartedBlock
PreSolveBlock

CollisionFilterCollisionFlags

Controls what parts of collision detection/resolution are run for a CollisionGroup pair.

EnumValueDescription
ResolveRun both collision detection and resolution as normal.
SkipDetectionDon't run collision detection. No events will be sent.
SkipResolutionDon't run collision resolution. Detection will still be run so events might be sent out.

CollisionType

Used to determine what kind of collision this is during event sending.

EnumValueDescription
CollisionEnded
CollisionPersisted
CollisionStarted

ConflictAction
EnumValueDescription
Replace
Skip

ConnectResponse
EnumValueDescription
Accept
Deny
DenyFull
DenyTimeout

ConnectResponseMode
EnumValueDescription
Accept
Custom
Deny

ConstraintPositionCorrection

What kind of position correction behavior is desired for constraint or constraint type.

EnumValueDescription
BaumgarteUse a baumgarte penalty force.
InheritUse the global position correction method.
PostStabilizationDirectly fix position errors via translation.

ControlMode
EnumValueDescription
FirstPerson
Orbit
ZPlane

ConvergenceState
EnumValueDescription
Active
None
Resting

CullMode

How triangles should be culled (not rendered) depending on which way they face.

EnumValueDescription
BackFaceClockwise triangles are not rendered.
DisabledTriangles are always rendered.
FrontFaceCounter clockwise triangles are not rendered.

Cursor

Standard Mouse Cursors.

EnumValueDescription
Arrow
Cross
Hand
Invisible
SizeAll
SizeNESW
SizeNS
SizeNWSE
SizeWE
TextBeam
Wait

CurveType
EnumValueDescription
BSpline
CatmullRom
Linear

DefaultAddOnFilters
EnumValueDescription
AllAngularAxes
AllAxes
AllLinearAxes
SingleAngularAxis
SingleAxis
SingleLinearAxis

DepthMode

How pixels depth values should be tested to determine if the pixel renders.

EnumValueDescription
DisabledNo depth testing.
ReadDepth values are compared to the depth buffer.
WriteDepth values are compared to the depth buffer, if comparison succeeds the new value is written to the buffer.

DetectionMode
EnumValueDescription
Assume
Automatic
Manual
Manumatic

DisconnectReason
EnumValueDescription
Latency
Request
Timeout

DockArea
EnumValueDescription
BotTool
Bottom
Center
Count
Floating
Left
Right
Top
TopTool

Ease
EnumValueDescription
BackIn
BackInOut
BackOut
BounceIn
BounceInOut
BounceOut
ElasticIn
ElasticInOut
ElasticOut
Linear
QuadIn
QuadInOut
QuadOut
SinIn
SinInOut
SinOut
WarpIn
WarpInOut
WarpOut

EditorMode
EnumValueDescription
Mode2D
Mode3D

Enum
EnumValueDescription

eUpdateTransformState

Internal enum used for determining what kind of transform update is happening.

EnumValueDescription
cInitialize
cUpdate

FalloffCurveType

The type of curve used for attenuating volume by SoundAttenuators.

EnumValueDescription
CustomSets the volume reduction using a SampleCurve resource.
LinearVolume reduces linearly with distance.
LogVolume reduces logarithmically, mimicking sound in real life.
SineVolume reduces linearly at first then slowly.
SquareRootVolume reduces quickly at first then linearly.
SquaredVolume reduces slowly at first then linearly.

Filter
EnumValueDescription
ActiveOffset
DefaultOffset
FilterFlag

FlickedStick
EnumValueDescription
Left
None
Right

FragmentCountFilter
EnumValueDescription
FiveFragments
FourFragments
OneFragment
SixFragments
ThreeFragments
TwoFragments

FragmentFilter
EnumValueDescription
FreeAngularFragment
FreeLinearFragment
NoFreeAxesFragment
SingleFragment

GeometryValue
EnumValueDescription
Albedo
Depth
Metallic
None
Normal
Roughness
Specular

GizmoBasis
EnumValueDescription
Local
World

GizmoDragMode
EnumValueDescription
Line
Plane
ViewPlane

GizmoGrab
EnumValueDescription
Hold
Toggle

GizmoGrabMode
EnumValueDescription
Hold
Toggle

GizmoPivot
EnumValueDescription
Average
Center
Primary

GizmoSnapMode
EnumValueDescription
Relative
WorldAxes
WorldGrid

GranularSynthWindows

Types of windows (volume envelopes) that can be used for individual grains generated by the GranularSynthNode .

EnumValueDescription
LinearA triangle-shaped linear envelope. Does not use attack and release times.
ParabolicA smoothly curved envelope. Does not use attack and release times.
RaisedCosineUses cosine curves to smoothly ramp up and down during attack and release times.
TrapezoidUses linear ramps during attack and release times. More efficient than RaisedCosine but not as smooth.

GraphicalSortMethod

Method of sorting for determining the draw order of graphicals.

EnumValueDescription
BackToFrontViewUses the distance in the view direction, furthest to nearest.
FrontToBackViewUses the distance in the view direction, nearest to furthest.
GraphicalSortValueUses the sort value on the graphical component, lowest to highest.
NegativeToPositiveXUses the world space X-coordinate.
NegativeToPositiveYUses the world space Y-coordinate.
NegativeToPositiveZUses the world space Z-coordinate.
NoneNot sorted, draw order is undefined.
PositiveToNegativeXUses the world space X-coordinate.
PositiveToNegativeYUses the world space Y-coordinate.
PositiveToNegativeZUses the world space Z-coordinate.
SortEventAn event is sent on CameraViewport every frame for custom logic to determine the sort value.

HeightTextureSelect
EnumValueDescription
Texture0
Texture1
Texture2
Texture3

HeightTool
EnumValueDescription
CreateDestroy
Flatten
RaiseLower
SmoothSharpen
WeightPainter

HorizontalAlignment
EnumValueDescription
Center
Left
Right

ImageImport
EnumValueDescription
Sprites
Textures

ImportFrames
EnumValueDescription
AllFrames
SelectedFrames

ImportMode
EnumValueDescription
FitToPatches
MaintainAspectRatio

IncludeMode
EnumValueDescription
Children
OnlyRoot

IndicatorSide
EnumValueDescription
Bottom
Left
Right
Top

InputDevice
EnumValueDescription
Gamepad
Joystick
Keyboard
Mouse

InternalKeyState
EnumValueDescription
KeyHeld
KeyNotHeld
KeyPressed
KeyReleased

InternetProtocol
EnumValueDescription
Both
Unspecified
V4
V6

JointFrameOfReference
EnumValueDescription
ObjectA
ObjectB

JointToolTypes
EnumValueDescription
FixedAngleJoint
GearJoint
LinearAxisJoint
ObjectLink
PositionJoint
PrismaticJoint
PrismaticJoint2d
PulleyJoint
RevoluteJoint
RevoluteJoint2d
StickJoint
UniversalJoint
UprightJoint
WeldJoint
WheelJoint
WheelJoint2d

JointTypes
EnumValueDescription
CustomJoint
FixedAngleJoint
GearJoint
LinearAxisJoint
ManipulatorJoint
PhyGunJoint
PositionJoint
PrismaticJoint
PrismaticJoint2d
PulleyJoint
RelativeVelocityJoint
RevoluteJoint
RevoluteJoint2d
StickJoint
UniversalJoint
UprightJoint
WeldJoint
WheelJoint
WheelJoint2d

Keys
EnumValueDescription
A
Add
Alt
Apostrophe
B
Back
Backslash
C
Capital
Comma
Control
D
Decimal
Delete
Divide
E
Eight
End
Enter
Equal
F
F1
F10
F11
F12
F2
F3
F4
F5
F6
F7
F8
F9
Five
Four
G
H
Home
I
Insert
J
K
L
LeftBracket
M
Minus
Multiply
N
Nine
None
NumPad0
NumPad1
NumPad2
NumPad3
NumPad4
NumPad5
NumPad6
NumPad7
NumPad8
NumPad9
O
One
P
PageDown
PageUp
Period
Q
R
RightBracket
S
Semicolon
Seven
Six
Slash
Space
Subtract
T
Three
Tilde
Two
U
Unknown
V
W
X
Y
Z
Zero

KeyState
EnumValueDescription
Down
Repeated
Up

LauncherAutoRunMode
EnumValueDescription
IfInstalled
InstallAndRun
None

LinkState
EnumValueDescription
Connected
Disconnected
ReceivedConnectRequest
ReceivedDisconnectNotice
ReceivedNegativeConnectResponse
SentConnectRequest
SentDisconnectNotice
SentNegativeConnectResponse
Unspecified

LinkStatus
EnumValueDescription
AttemptingConnection
Connected
Disconnected
Unspecified

Location
EnumValueDescription
BottomCenter
BottomLeft
BottomRight
Center
CenterLeft
CenterRight
TopCenter
TopLeft
TopRight

LoopingMode
EnumValueDescription
Default
Looping
Once

MeshEmitMode
EnumValueDescription
Edge
Face
Vertex

MeshImport
EnumValueDescription
MultiMesh
NoMesh
SingleMesh

Mode2DStates

Represents what dimensions a RigidBody should operate in (how many degrees of freedom it has by default).

EnumValueDescription
InheritFromSpaceUse the Mode2D state on the PhysicsSpace . This allows easy changing of the entire space between 2D/3D.
Mode2DRestricts the object's movement through physics to 2D. This lowers the object's degrees of freedom down to 3 (x-linear, y-linear, z-angular).
Mode3DA regular 3D object (6 degrees of freedom).

MouseButtons

As the extra mouse buttons are typically Back and Forward they have been named accordingly.

EnumValueDescription
Left
Middle
None
Right
XOneBack
XTwoForward

MultiConvexMeshAutoComputeMethod
EnumValueDescription
MarchingSquares
Pixels

MultiConvexMeshAutoComputeMode
EnumValueDescription
Alpha
Intensity

MultiConvexMeshDrawMode
EnumValueDescription
Edges
Filled
None

MultiConvexMeshSnappingMode
EnumValueDescription
Always
IfClose
None

NetRefreshResult

Network refresh result.

EnumValueDescription
DirectBasicHostInfo
ExtraHostInfo
IndirectBasicHostInfo
NoResponse

NetRole
EnumValueDescription
Client
MasterServer
Offline
Server
Unspecified

NetUserAddResponse

Network user add response.

EnumValueDescription
Accept
Deny

Network

Network specification.

EnumValueDescription
Internet
LAN

ObjectIndex
EnumValueDescription
IndexA
IndexB

OrientationBases
EnumValueDescription
Custom
ForwardNegativeZUpY
ForwardXUpY
ForwardXUpZ
ForwardYUpZ
ForwardZUpY

PerspectiveMode

Method of 3D scene projection to a 2D plane.

EnumValueDescription
OrthographicProjection is parallel with the viewing direction.
PerspectiveProjection towards a single view point, making distant objects appear smaller.

PhysicsContactTangentTypes

How to compute the tangents for a contact point. Mainly for testing.

EnumValueDescription
OrthonormalTangents
RandomTangents
VelocityTangents

PhysicsEffectEndCondition

Describes how interpolation is performed (if at all) outside of a physics effect's max distance.

EnumValueDescription
ClampToMaxClamps to the max force value
ContinueFalloffContinue the regular interpolation method
NoEffectDon't apply a force past the max distance

PhysicsEffectInterpolationType

Describes how force values are interpolated between min/max values.

EnumValueDescription
LinearLinearly interpolate between values.
QuadraticQuadratically interpolate between values (uses t^2).

PhysicsEffectType
EnumValueDescription
Buoyancy
Custom
Drag
Flow
Force
Gravity
Invalid
PointForce
PointGravity
Thrust
Torque
Vortex
Wind

PhysicsImport
EnumValueDescription
ConvexMesh
NoMesh
StaticMesh

PhysicsIslandPreProcessingMode

What kind of pre-processing strategy should be used for merging islands.

EnumValueDescription
ColliderCount
ConstraintCount
None

PhysicsIslandType

How should islands be built. Internal for testing (mostly legacy).

EnumValueDescription
Composites
ForcedOne
Kinematics

PhysicsMeshType
EnumValueDescription
ConvexMesh
PhysicsMesh

PhysicsSolverPositionCorrection

What kind of position correction should be applied for any constraint that is set to Inherit.

EnumValueDescription
BaumgarteUse a baumgarte penalty force.
PostStabilizationDirectly fix position errors via translation.

PhysicsSolverSubType

What kind of solver technique to use for position correction. Mainly for testing.

EnumValueDescription
BasicSolving
BlockSolving

PhysicsSolverType

What kind of a constraint solver should be used. A few pre-defined types meant for comparing performance.

EnumValueDescription
Basic
GenericBasic
Normal
Threaded

Placement
EnumValueDescription
CameraLocation
LookAtPlane
LookAtPoint
OnTop
PlaneXY
ViewAtDepth

PlayGameOptions
EnumValueDescription
MultipleInstances
SingleInstance

PrimitiveType
EnumValueDescription
Lines
Points
Triangles

Receipt
EnumValueDescription
ACK
EXPIRED
MAYBE
NAK

ReceiveState
EnumValueDescription
cCloseConnection
cDataReceived
cNextConnection

ReliabilityMode
EnumValueDescription
Reliable
Unreliable

ReplicationPhase
EnumValueDescription
Change
Initialization
Uninitialization

RigidBodyDynamicState

What kind of dynamics this body should have. Determines if forces are integrated and if collisions are resolved.

EnumValueDescription
DynamicA regular body that can be affected by forces.
KinematicAn infinite mass body that approximates velocity when moved. Used for moving platforms and other movable infinite mass objects.
StaticAn infinite mass body. Will not move via dynamics.

RouteMode
EnumValueDescription
Exclude
Include

ScaleConversion
EnumValueDescription
CentimeterToInches
CentimeterToMeter
Custom
InchesToCentimenters
InchesToMeters
MetersToCentimeters
MetersToInches

SendsEvents
EnumValueDescription
False
True

SerializationMode
EnumValueDescription
All
Changed

ShadowResolution
EnumValueDescription
High
Low
Medium

SoundPlayMode

Whether a SoundCue should play once or loop continuously.

EnumValueDescription
LoopingThe sound will loop continuously between its LoopStartTime and LoopEndTime.
SingleThe sound will play once to its EndTime and then stop.

SoundSelectMode

Whether a SoundCue should pick a Sound to play randomly or sequentially.

EnumValueDescription
RandomThe SoundCue will pick a Sound at random, taking into account the Weight values.
SequentialEach time the SoundCue is played it will pick the next Sound in the order they are displayed.

SplineAnimatorMode
EnumValueDescription
Exact
Spring

SplineType
EnumValueDescription
BSpline
CatmullRom
Linear

SpringDebugDrawMode

When should debug drawing of a spring system happen.

EnumValueDescription
AlwaysAlways debug draw.
NoneNever debug draw.
WhenNoMeshOnly debug draw if no graphical mesh is present.

SpringDebugDrawType

How should springs be drawn?

EnumValueDescription
NormalDraw all springs equally (same color).
SortedDraw the springs in sorted order. This alters the color based upon the distance from an anchor point.

SpringSortOrder

How should springs be sorted for solving. This effects the convergence rate of a system.

EnumValueDescription
BottomUpSort so that springs further away from anchors are solved first.
NoneNo sorting is preserved.
TopDownSort so that springs closer to anchors are solved first.

SpringSubTools
EnumValueDescription
Anchoring
PointSelector
RopeCreator
SpringCreator
SpringSelector

SpriteFill
EnumValueDescription
NineSlice
Stretch
Tiled

SpriteGeometryMode

How the sprite quad is aligned in 3D space.

EnumValueDescription
ViewPlaneAligned to always face the camera.
ZPlaneAligned with the object's z axis.

SpriteOrigin
EnumValueDescription
BottomCenter
BottomLeft
Center
Custom
UpperLeft

SpriteParticleAnimationMode
EnumValueDescription
Looping
Single

SpriteParticleGeometryMode

Sprite Particle System Enums.

EnumValueDescription
Beam
Billboarded
FaceVelocity
Flat
Outward

SpriteParticleSortMode
EnumValueDescription
BackToFrontView
FrontToBackView
NegativeToPositiveX
NegativeToPositiveY
NegativeToPositiveZ
None
PositiveToNegativeX
PositiveToNegativeY
PositiveToNegativeZ

SpriteSampling
EnumValueDescription
Linear
Nearest

StencilMode

How stencil buffer values should be tested to determine if a pixel renders.

EnumValueDescription
DisabledNo stencil testing.
EnabledStencil values will be tested with the active settings.
SeparateStencil values will be tested, frontface/backface triangles will use separate settings.

StencilOp

Operations that can be applied to the stencil buffer.

EnumValueDescription
DecrementDecrements the current stencil buffer value. Clamps to 0.
DecrementWrapDecrements the current stencil buffer value. Wraps stencil buffer value to the maximum value when decrementing a stencil buffer value of zero.
IncrementIncrements the current stencil buffer value. Clamps to the maximum value.
IncrementWrapIncrements the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum value.
InvertBitwise inverts the current stencil buffer value.
KeepKeeps the current value.
ReplaceSets the stencil buffer value to the test value.
Zero

StoreResult
EnumValueDescription
Added
Failed
Replaced

StreamOrigin
EnumValueDescription
Current
End
Start

StreamType
EnumValueDescription
StandardError
StandardInput
StandardOutput

SynthWaveType

Types of sound waves that can be used by SoundNodes.

EnumValueDescription
NoiseWhite noise produced by getting random values between -1 and 1.
SawWaveAudio generated by a saw wave (values go linearly from -1 to 1 then jump back to -1).
SineWaveAudio generated by a Sine wave.
SquareWaveAudio generated by a square wave (values are either -1 or 1).
TriangleWaveAudio generated by a triangle wave (values go linearly from -1 to 1 and back again).

SystemSpace
EnumValueDescription
LocalSpace
WorldSpace

TabWidth
EnumValueDescription
FourSpaces
TwoSpaces

TcpSocketBind
EnumValueDescription
Any
Loopback

TextAlign

How text is positioned relative to the object position.

EnumValueDescription
CenterCenter is aligned with the position.
LeftLeft side is aligned with the position.
RightRight side is aligned with the position.

TextureAddressing

How to address the texture with uv's outside of the range [0, 1] Clamp - Uses the last pixel at the border of the image Repeat - Wraps to the opposite side and continues to sample the image Mirror - Similar to Repeat but reverses image direction.

EnumValueDescription
Clamp
Mirror
Repeat

TextureAnisotropy

How pixels are sampled when the ratio of pixels viewed along its u/v directions is not 1:1 (Typically when viewing a texture at an angle) The options represent how large of a ratio will be accounted for when sampling x1 = 1:1 (no anisotropy), x16 = 16:1 (high anisotropy), x16 being the best quality.

EnumValueDescription
x1
x16
x2
x4
x8

TextureCompareFunc

Method of comparison used when testing values against textures/buffers.

EnumValueDescription
AlwaysCompare always succeeds.
EqualCompares if test value is equal to buffer value.
GreaterCompares if test value is greater than buffer value.
GreaterEqualCompares if test value is greater than or equal to buffer value.
LessCompares if test value is less than buffer value.
LessEqualCompares if test value is less than or equal to buffer value.
NeverCompare never succeeds.
NotEqualCompares if test value is not equal to buffer value.

TextureCompareMode

If texture sampling should do comparison.

EnumValueDescription
DisabledRegular texture sampling.
EnabledSampling returns the result of a comparison.

TextureCompression

Block compression, lossy hardware supported formats with very high memory savings None - No compression will be used BC1 - RGB stored at 1/2 byte per pixel Used for color maps that don't need alpha, normal maps BC2 - RGB w/ low precision alpha stored at 1 byte per pixel No common usages BC3 - RGB w/ alpha stored at 1 byte per pixel Used for color maps that need alpha BC4 - R stored at 1/2 byte per pixel Used for single channel maps like height, specular, roughness BC5 - RG stored at 1 byte per pixel Used for two channel maps like normals with reconstructed Z BC6 - RGB floats stored at 1 byte per pixel Used for high dynamic range images.

EnumValueDescription
BC1
BC2
BC3
BC4
BC5
BC6
None

TextureFace
EnumValueDescription
NegativeX
NegativeY
NegativeZ
None
PositiveX
PositiveY
PositiveZ

TextureFiltering

How pixels are sampled when viewing image at a different size Nearest - Gets the closest pixel unaltered Bilinear - Gets the 4 closest pixels and linearly blends between them Trilinear - Same as bilinear with an additional linear blend between mip levels.

EnumValueDescription
Bilinear
Nearest
Trilinear

TextureFormat
EnumValueDescription
Depth16
Depth24
Depth24Stencil8
Depth32
Depth32f
Depth32fStencil8Pad24
None
R16
R16f
R32f
R8
RG16
RG16f
RG32f
RG8
RGB16
RGB16f
RGB32f
RGB8
RGBA16
RGBA16f
RGBA32f
RGBA8
SRGB8
SRGB8A8

TextureMipMapping

Progressively scaled down versions of the image are produced to preserve image integrity when viewed at smaller scales None - No mipmaps are generated PreGenerated - Mipmaps are generated by the engine Uses higher quality filtering than the gpu Required for cubemaps in order to get perspective correct filtering over face edges GpuGenerated - Mipmaps are generated by the gpu at load time.

EnumValueDescription
GpuGenerated
None
PreGenerated

TextureType

Type of the texture, must match sampler type in shaders Texture2D - Standard 2 dimensional texture TextureCube - Uses texture as a cubemap Faces are extracted from the image using aspect ratio to determine layout.

EnumValueDescription
Texture2D
TextureCube

TileEditor2DSubToolType
EnumValueDescription
DrawTool
SelectionTool

TimeDisplay
EnumValueDescription
Frames
Timecodes

TimeMode
EnumValueDescription
ActualFrametime
FixedFrametime

ToolTipColorScheme
EnumValueDescription
Default
Gray
Green
Orange
Red
Yellow

TrackType
EnumValueDescription
Component
Invalid
Object
Property
SubProperty

TransferMode
EnumValueDescription
Immediate
Ordered
Sequenced

TransmissionDirection
EnumValueDescription
Incoming
Outgoing
Unspecified

TransportProtocol
EnumValueDescription
Tcp
Udp
Unspecified

UiDockMode
EnumValueDescription
Bottom
Left
Right
Top

UiFocusDirection
EnumValueDescription
Backward
Forward

UiHighlightColorMode
EnumValueDescription
Hierarchy
Local

UiHighlightColorOp
EnumValueDescription
Add
Multiply
Set

UiHighlightMouseMode
EnumValueDescription
Enter
EnterHierarchy
Hover

UiHorizontalAlignment
EnumValueDescription
Center
Left
Right

UiScrollBarAxis
EnumValueDescription
X
Y

UiSizePolicy
EnumValueDescription
Auto
Fixed
Flex

UiStackLayoutDirection
EnumValueDescription
BottomToTop
LeftToRight
RightToLeft
TopToBottom

UiVerticalAlignment
EnumValueDescription
Bottom
Center
Top

UpdateMode
EnumValueDescription
None
TranslateRoot
TranslateSelf

UserConnectResponse
EnumValueDescription
Accept
Deny
Pending

Verbosity
EnumValueDescription
Detailed
Minimal

VertexElementType
EnumValueDescription
Byte
Half
NormByte
NormShort
Real
Short

VertexSemantic
EnumValueDescription
Aux0
Aux1
Aux2
Aux3
Aux4
Aux5
Bitangent
BoneIndices
BoneWeights
Color
ColorAux
None
Normal
Position
Tangent
Uv
UvAux

VerticalAlignment
EnumValueDescription
Bottom
Center
Top

ViewportScaling

How the viewport should be sized within the window size.

EnumValueDescription
ExactViewport is not scaled.
FillViewport fills the whole size.
LargestMultipleViewport is the largest multiple of the set resolution that fits in the window.
LetterboxViewport aspect ratio is always preserved.

WebBrowserModifiers
EnumValueDescription
Alt
CapsLock
Command
Control
IsKeyPad
IsLeft
IsRight
LeftMouse
MiddleMouse
NumLock
RightMouse
Shift

WindowState

The state of the window for minimizing / maximizing.

EnumValueDescription
Fullscreen
Maximized
Minimized
Restore
Windowed

WindowStyleFlags
EnumValueDescription
ClientOnly
Close
MainWindow
NotVisible
OnTaskBar
Resizable
TitleBar

Last Author
arend.danielek
Last Edited
Aug 22 2018, 10:58 AM
Projects
Subscribers
None