Playground

The engine's WebAssembly build, running right here in your browser. Edit JavaScript against it, hit Run, and read the output — the same Wasm instance the engine's own unit tests use, nothing to install.

Get the Engine →
Canvas
Console
Starting the WebAssembly engine…
playground.js

What's in scope

Click a namespace for its full documentation.

nkMaths

nkMaths

Vectors, quaternions, matrices

Automatically generated at build time from the shipped engine giving the complete in-scope API.

enumMathConstants9 members

Methods

  • PI = 3.1415927410125732
  • PI_SQRT = 1.7724539041519165
  • PI_2 = 6.2831854820251465
  • PI_4 = 12.566370964050293
  • PI_OVER_2 = 1.5707963705062866
  • PI_OVER_3 = 1.0471975803375244
  • PI_OVER_4 = 0.7853981852531433
  • PI_OVER_6 = 0.5235987901687622
  • PI_OVER_8 = 0.39269909262657166
classRectangle6 members

Constructors

  • Rectangle()

Properties

  • _xr/w
  • _yr/w
  • _widthr/w
  • _heightr/w

Methods

  • pointInside(arg0)
classHasher4 members

Static methods

  • statichashString(arg0)
  • statichashNumber(arg0)
  • staticcombineIntoHashString(arg0, arg1)
  • staticcombineIntoHashNumber(arg0, arg1)
classMatrixmanaged + unmanaged50 members

Constructors

  • Matrix()
  • Matrix(a)
  • Matrix(a, b, c, d)
  • Matrix(a, b, c, d, e, f, g, h, i)
  • Matrix(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p)

Properties

  • _mr/w= [[1,0,0,0],[0,1,0,0],[0,0,1,0],[0,0,0,1]]

Methods

  • getRow0()+ getRow0_u()
  • getRow1()+ getRow1_u()
  • getRow2()+ getRow2_u()
  • getRow3()+ getRow3_u()
  • getCol0()+ getCol0_u()
  • getCol1()+ getCol1_u()
  • getCol2()+ getCol2_u()
  • getCol3()+ getCol3_u()
  • get(row, col)
  • set(val, row, col)
  • getInverseMat2()+ getInverseMat2_u()
  • getInverseMat3()+ getInverseMat3_u()
  • getInverseMat4()+ getInverseMat4_u()
  • getTranspose()+ getTranspose_u()
  • inverseMat2()
  • inverseMat3()
  • inverseMat4()
  • transpose()
  • getPositionComponent()+ getPositionComponent_u()
  • getOrientationComponent()+ getOrientationComponent_u()
  • getScaleComponent()+ getScaleComponent_u()
  • setToViewMatrixDirection(pos, dir, up)
  • setToPerspectiveMatrix(fov, aspect, nearVal, farVal)
  • setToOrthographicMatrix(width, height, nearVal, farVal)
  • setPositionComponent(pos)
  • setOrientationComponent(rot)
  • setScaleComponent(scale)
  • setToTransformation(pos, rot, scale)
  • getDeterminantMat2()
  • getDeterminantMat3()
  • getDeterminantMat4()
  • getTraceMat2()
  • getTraceMat3()
  • getTraceMat4()
  • assign(m)
  • equals(m)
  • clone()+ clone_u()
  • add(m)+ add_u()
  • sub(m)+ sub_u()
  • mul(m)+ mul_u()
  • mulVector(v)+ mulVector_u()
  • mulQuaternion(q)+ mulQuaternion_u()
  • mulScalar(b)+ mulScalar_u()
  • divScalar(b)+ divScalar_u()
classQuaternionmanaged + unmanaged21 members

Constructors

  • Quaternion()
  • Quaternion(a)
  • Quaternion(a, b)
  • Quaternion(a, b, c, d)

Properties

  • _xr/w= 0
  • _yr/w= 0
  • _zr/w= 0
  • _wr/w= 1

Methods

  • getAsEulerAngles()+ getAsEulerAngles_u()
  • getAsAxisAngle()+ getAsAxisAngle_u()
  • setFromAxisAngle(axis, angle)
  • setFromEuler(angles)
  • setFromOrientationMatrix(mat)
  • setFromTransformationMatrix(mat)
  • transform(v)+ transform_u()
  • apply(v)
  • equals(q)
  • assign(q)
  • clone()+ clone_u()
  • mul(q)+ mul_u()
  • mulVector(v)+ mulVector_u()
classVectormanaged + unmanaged58 members

Constructors

  • Vector()
  • Vector(a)
  • Vector(a, b)
  • Vector(a, b, c)
  • Vector(a, b, c, d)

Properties

  • _xr/w= 0
  • _yr/w= 0
  • _zr/w= 0
  • _wr/w= 0

Methods

  • getLengthVec2()
  • getLengthVec3()
  • getLengthVec4()
  • getLengthSquaredVec2()
  • getLengthSquaredVec3()
  • getLengthSquaredVec4()
  • getDistanceVec2(b)
  • getDistanceVec3(b)
  • getDistanceVec4(b)
  • getDistanceSquaredVec2(b)
  • getDistanceSquaredVec3(b)
  • getDistanceSquaredVec4(b)
  • normalizeVec2()
  • normalizeVec3()
  • normalizeVec4()
  • getNormalizedVec2()+ getNormalizedVec2_u()
  • getNormalizedVec3()+ getNormalizedVec3_u()
  • getNormalizedVec4()+ getNormalizedVec4_u()
  • dotProductVec2(b)
  • dotProductVec3(b)
  • dotProductVec4(b)
  • setAsCrossVec3(b)
  • getCrossVec3(b)+ getCrossVec3_u()
  • assign(b)
  • equals(b)
  • clone()+ clone_u()
  • add(b)+ add_u()
  • addScalar(b)+ addScalar_u()
  • sub(b)+ sub_u()
  • subScalar(b)+ subScalar_u()
  • mul(b)+ mul_u()
  • mulScalar(b)+ mulScalar_u()
  • mulQuaternion(b)+ mulQuaternion_u()
  • div(b)+ div_u()
  • divScalar(b)+ divScalar_u()
  • inf(b)
  • infOrEqual(b)
  • greater(b)
  • greaterOrEqual(b)

Static methods

  • staticdistanceVec2(a, b)
  • staticdistanceVec3(a, b)
  • staticdistanceVec4(a, b)
  • staticdistanceSquaredVec2(a, b)
  • staticdistanceSquaredVec3(a, b)
  • staticdistanceSquaredVec4(a, b)
  • staticdotVec2(a, b)
  • staticdotVec3(a, b)
  • staticdotVec4(a, b)
  • staticcrossVec3(a, b)+ crossVec3_u()
classPointmanaged + unmanaged4 members

Constructors

  • Point()
  • Point(a, b)

Properties

  • _xr/w= 0
  • _yr/w= 0
nkMemory

nkMemory

Buffers and buffer views

Automatically generated at build time from the shipped engine giving the complete in-scope API.

classString2 members

Methods

  • getData()
  • getSize()
classStringView1 member

Constructors

  • StringView(a)
classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classBuffermanaged + unmanaged15 members

Constructors

  • Buffer()
  • Buffer(a)
  • Buffer(a, b)

Properties

  • _datareadonly= null

Methods

  • getData()
  • getSize()
  • empty()
  • front()
  • back()
  • clear()
  • resize(size)
  • append(value)
  • erase(index, count=1)
  • get(index)
  • assign(b)
classBufferViewmanaged + unmanaged11 members

Constructors

  • BufferView()
  • BufferView(a)
  • BufferView(a, b)

Properties

  • _datareadonly= null
  • _underlyingUnmanagedreadonly= false
  • _underlyingUnmanagedBufferreadonly= null

Methods

  • getData()
  • getSize()
  • empty()
  • front()
  • back()
nkScripts

nkScripts

Lua scripts, environments, interpreters

Automatically generated at build time from the shipped engine giving the complete in-scope API.

enumEXECUTION_FAILURE_TYPE7 members

Methods

  • NO_ERROR
  • UNKNOWN
  • INTERPRETER_UNKNOWN
  • INTERPRETER_TYPE_MISMATCH
  • BYTECODE_NOT_READY
  • RUNTIME
  • MEMORY_ALLOCATION
enumFUNCTION_PARAMETER_TYPE10 members

Methods

  • VOID
  • BOOL
  • INT
  • FLOAT
  • DOUBLE
  • STRING
  • USER_DATA
  • USER_DATA_PTR
  • SCRIPT_FUNCTION
  • SCRIPT_OBJECT
enumTYPE_BUILT_IN_FUNCTIONS12 members

Methods

  • BUILT_IN_TO_STRING
  • BUILT_IN_UNARY_MINUS
  • BUILT_IN_ADD
  • BUILT_IN_SUB
  • BUILT_IN_MUL
  • BUILT_IN_DIV
  • BUILT_IN_MOD
  • BUILT_IN_POW
  • BUILT_IN_CONCAT
  • BUILT_IN_EQ
  • BUILT_IN_LT
  • BUILT_IN_LE
enumINTERPRETER2 members

Methods

  • UNKNOWN
  • LUA
enumCOMPILATION_FAILURE_TYPE5 members

Methods

  • NO_ERROR
  • UNKNOWN
  • INTERPRETER_UNKNOWN
  • SYNTAX
  • MEMORY_ALLOCATION
classEnvironment27 members

Methods

  • getName()
  • getLastExecutionResult()+ getLastExecutionResult_u()
  • setEnvironmentFor(arg0)
  • setName(arg0)
  • setVarBool(arg0, arg1)
  • setVarInt(arg0, arg1)
  • setVarFloat(arg0, arg1)
  • setVarString(arg0, arg1)
  • isVarSet(arg0)
  • getVarBool(arg0, arg1)
  • getVarInt(arg0, arg1)
  • getVarFloat(arg0, arg1)
  • getVarString(arg0, arg1)
  • getScriptFunction(arg0)
  • setFunc(arg0)
  • isFuncSet(arg0)
  • getFunc(arg0)
  • setUserType(arg0)
  • isUserTypeSet(arg0)
  • getUserType(arg0)
  • setNamespace(arg0)
  • isNamespaceSet(arg0)
  • getNamespace(arg0)
  • execute(arg0)
  • requestGarbageCollection()
  • callScriptFunction(arg0, arg1, arg2)

Static methods

  • staticcreate(...args)
classEnvironmentManager7 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • getByIndex(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
  • statickill()
classFunction4 members

Methods

  • getName()
  • addParameter(...args)
  • setFunction(arg0)
  • reset()
classDataStack3 members

Constructors

  • DataStack()

Methods

  • getSize()
  • get(arg0)
classNamespace12 members

Methods

  • getName()
  • getNamespace(arg0)
  • getUserType(...args)
  • setVarBool(arg0, arg1)
  • setVarInt(arg0, arg1)
  • setVarFloat(arg0, arg1)
  • setVarString(arg0, arg1)
  • setFunc(arg0)
  • setUserType(arg0)
  • setNamespace(arg0)
  • shutdown()
  • reset()
classScriptObjectReference4 members

Constructors

  • ScriptObjectReference()
  • ScriptObjectReference(a)

Methods

  • getType()
  • isValid()
classScriptObjectView1 member

Constructors

  • ScriptObjectView()
classUserType7 members

Methods

  • getName()
  • getFullName()
  • getMethod(arg0)
  • getStaticMethod(arg0)
  • addMethod(...args)
  • addStaticMethod(arg0)
  • overrideBuiltInFunction(arg0)
classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classScript10 members

Constructors

  • Script()

Methods

  • getTargetInterpreter()
  • getName()
  • getSources()
  • getLastCompilationResult()+ getLastCompilationResult_u()
  • setTargetInterpreter(arg0)
  • setName(arg0)
  • setSources(arg0)
  • load()
  • unload()
classScriptManager7 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • getByIndex(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
  • statickill()
classExecutionResultmanaged + unmanaged4 members

Constructors

  • ExecutionResult(a, b, c)

Properties

  • _failureMessager/w= ""
  • _failureTyper/w= nkScripts.EXECUTION_FAILURE_TYPE.NO_ERROR
  • _successr/w= true
classFunctionParametermanaged + unmanaged10 members

Constructors

  • FunctionParameter()
  • FunctionParameter(a)

Properties

  • _valBoolr/w= false
  • _valIntr/w= 0
  • _valFloatr/w= 0
  • _valStringr/w= ""
  • _valUserreadonly= null
  • _valScriptObjectr/w= null
  • _typer/w= nkScripts.FUNCTION_PARAMETER_TYPE.VOID
  • _valDoubler/w
classCompilationResultmanaged + unmanaged4 members

Constructors

  • CompilationResult(a, b, c)

Properties

  • _failureMessager/w= ""
  • _failureTyper/w= nkScripts.COMPILATION_FAILURE_TYPE.NO_ERROR
  • _successr/w= true
nkGraphics

nkGraphics

Buffers, cameras, render contexts

Automatically generated at build time from the shipped engine giving the complete in-scope API.

enumBUFFER_BIND_FLAG11 members

Methods

  • BIND_NONE
  • BIND_VERTEX_BUFFER
  • BIND_INDEX_BUFFER
  • BIND_CONSTANT_BUFFER
  • BIND_SHADER_RESOURCE
  • BIND_STREAM_OUTPUT
  • BIND_RENDER_TARGET
  • BIND_DEPTH_STENCIL
  • BIND_UNORDERED_ACCESS
  • BIND_DECODER
  • BIND_VIDEO_ENCODER
enumBUFFER_CPU_ACCESS_FLAG4 members

Methods

  • CPU_ACCESS_NONE
  • CPU_ACCESS_WRITE
  • CPU_ACCESS_READ
  • CPU_ACCESS_READ_WRITE
enumBUFFER_USAGE4 members

Methods

  • USAGE_DEFAULT
  • USAGE_IMMUTABLE
  • USAGE_DYNAMIC
  • USAGE_STAGING
enumOBJ_SPACE2 members

Methods

  • UP_Y_FRONT_Z
  • UP_Y_FRONT_MINUS_Z
enumATTRIBUTE_GRANULARITY2 members

Methods

  • PER_VERTEX
  • PER_INSTANCE
enumINDEX_FORMAT2 members

Methods

  • UINT16
  • UINT32
enumPRIMITIVE_TOPOLOGY10 members

Methods

  • PRIMITIVE_TOPOLOGY_UNDEFINED
  • POINTLIST
  • LINELIST
  • LINESTRIP
  • TRIANGLELIST
  • TRIANGLESTRIP
  • LINELIST_ADJ
  • LINESTRIP_ADJ
  • TRIANGLELIST_ADJ
  • TRIANGLESTRIP_ADJ
enumDATA_FILL_TYPE3 members

Methods

  • COPY
  • FORWARD
  • REFERENCE
enumPASS_TYPE8 members

Methods

  • UNKNOWN
  • CLEAR_TARGETS
  • COMPUTE
  • INSTANCING
  • MONO_MATERIAL
  • POST_PROCESS
  • RENDER_SCENE
  • RAYTRACING
enumPROGRAM_TYPE5 members

Methods

  • UNKNOWN
  • COMPUTE
  • GEOMETRY
  • PIPELINE
  • RAYTRACING
enumBLEND17 members

Methods

  • BLEND_ZERO
  • BLEND_ONE
  • BLEND_SRC_COLOR
  • BLEND_INV_SRC_COLOR
  • BLEND_SRC_ALPHA
  • BLEND_INV_SRC_ALPHA
  • BLEND_DEST_ALPHA
  • BLEND_INV_DEST_ALPHA
  • BLEND_DEST_COLOR
  • BLEND_INV_DEST_COLOR
  • BLEND_SRC_ALPHA_SAT
  • BLEND_BLEND_FACTOR
  • BLEND_INV_BLEND_FACTOR
  • BLEND_SRC1_COLOR
  • BLEND_INV_SRC1_COLOR
  • BLEND_SRC1_ALPHA
  • BLEND_INV_SRC1_ALPHA
enumBLEND_OP5 members

Methods

  • BLEND_OP_ADD
  • BLEND_OP_SUBTRACT
  • BLEND_OP_REV_SUBTRACT
  • BLEND_OP_MIN
  • BLEND_OP_MAX
enumCOLOR_WRITE_ENABLE5 members

Methods

  • COLOR_WRITE_ENABLE_RED
  • COLOR_WRITE_ENABLE_GREEN
  • COLOR_WRITE_ENABLE_BLUE
  • COLOR_WRITE_ENABLE_ALPHA
  • COLOR_WRITE_ENABLE_ALL
enumFILL_MODE2 members

Methods

  • FILL_WIREFRAME
  • FILL_SOLID
enumCULL_MODE3 members

Methods

  • CULL_NONE
  • CULL_FRONT
  • CULL_BACK
enumRENDERING_API2 members

Methods

  • AUTOMATIC
  • GLES
enumRESOURCE_LOAD_STATE4 members

Methods

  • UNLOADED
  • LOADING
  • READY_FOR_RENDERING
  • LOADED
enumRESOURCE_MISC_FLAG18 members

Methods

  • RESOURCE_MISC_NONE
  • RESOURCE_MISC_GENERATE_MIPS
  • RESOURCE_MISC_SHARED
  • RESOURCE_MISC_TEXTURECUBE
  • RESOURCE_MISC_DRAWINDIRECT_ARGS
  • RESOURCE_MISC_BUFFER_ALLOW_RAW_VIEWS
  • RESOURCE_MISC_BUFFER_STRUCTURED
  • RESOURCE_MISC_RESOURCE_CLAMP
  • RESOURCE_MISC_SHARED_KEYEDMUTEX
  • RESOURCE_MISC_GDI_COMPATIBLE
  • RESOURCE_MISC_SHARED_NTHANDLE
  • RESOURCE_MISC_RESTRICTED_CONTENT
  • RESOURCE_MISC_RESTRICT_SHARED_RESOURCE
  • RESOURCE_MISC_RESTRICT_SHARED_RESOURCE_DRIVER
  • RESOURCE_MISC_GUARDED
  • RESOURCE_MISC_TILE_POOL
  • RESOURCE_MISC_TILED
  • RESOURCE_MISC_HW_PROTECTED
enumRESOURCE_TYPE13 members

Methods

  • UNKNOWN
  • COMPOSITOR
  • MESH
  • BLEND_STATE
  • DEPTH_STENCIL_STATE
  • RASTER_STATE
  • PROGRAM
  • SHADER
  • BUFFER
  • ACCELERATION_STRUCTURE
  • TEXTURE
  • SAMPLER
  • NODE_WRAPPER
enumCOMPARISON_FUNCTION8 members

Methods

  • FUNCTION_NEVER
  • FUNCTION_LESS
  • FUNCTION_EQUAL
  • FUNCTION_LESS_EQUAL
  • FUNCTION_GREATER
  • FUNCTION_NOT_EQUAL
  • FUNCTION_GREATER_EQUAL
  • FUNCTION_ALWAYS
enumFILTER36 members

Methods

  • MIN_MAG_MIP_POINT
  • MIN_MAG_POINT_MIP_LINEAR
  • MIN_POINT_MAG_LINEAR_MIP_POINT
  • MIN_POINT_MAG_MIP_LINEAR
  • MIN_LINEAR_MAG_MIP_POINT
  • MIN_LINEAR_MAG_POINT_MIP_LINEAR
  • MIN_MAG_LINEAR_MIP_POINT
  • MIN_MAG_MIP_LINEAR
  • ANISOTROPIC
  • COMPARISON_MIN_MAG_MIP_POINT
  • COMPARISON_MIN_MAG_POINT_MIP_LINEAR
  • COMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINT
  • COMPARISON_MIN_POINT_MAG_MIP_LINEAR
  • COMPARISON_MIN_LINEAR_MAG_MIP_POINT
  • COMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEAR
  • COMPARISON_MIN_MAG_LINEAR_MIP_POINT
  • COMPARISON_MIN_MAG_MIP_LINEAR
  • COMPARISON_ANISOTROPIC
  • MINIMUM_MIN_MAG_MIP_POINT
  • MINIMUM_MIN_MAG_POINT_MIP_LINEAR
  • MINIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT
  • MINIMUM_MIN_POINT_MAG_MIP_LINEAR
  • MINIMUM_MIN_LINEAR_MAG_MIP_POINT
  • MINIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR
  • MINIMUM_MIN_MAG_LINEAR_MIP_POINT
  • MINIMUM_MIN_MAG_MIP_LINEAR
  • MINIMUM_ANISOTROPIC
  • MAXIMUM_MIN_MAG_MIP_POINT
  • MAXIMUM_MIN_MAG_POINT_MIP_LINEAR
  • MAXIMUM_MIN_POINT_MAG_LINEAR_MIP_POINT
  • MAXIMUM_MIN_POINT_MAG_MIP_LINEAR
  • MAXIMUM_MIN_LINEAR_MAG_MIP_POINT
  • MAXIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEAR
  • MAXIMUM_MIN_MAG_LINEAR_MIP_POINT
  • MAXIMUM_MIN_MAG_MIP_LINEAR
  • MAXIMUM_ANISOTROPIC
enumTEXTURE_ADDRESS_MODE5 members

Methods

  • PER_VERTEX
  • MODE_MIRROR
  • MODE_CLAMP
  • MODE_BORDER
  • MODE_MIRROR_ONCE
enumShaderInstanceMemorySlot1 member

Methods

  • DATA_TYPE
enumShaderPassMemorySlot1 member

Methods

  • DATA_TYPE
enumTEXTURE_TYPE3 members

Methods

  • TEXTURE_2D
  • TEXTURE_3D
  • TEXTURE_CUBEMAP
enumTEXTURE_RENDER_FLAG3 members

Methods

  • NO_RENDER
  • RENDER_TARGET
  • DEPTH_RENDER_TARGET
enumFORMAT90 members

Methods

  • UNKNOWN_FORMAT
  • R32G32B32A32_TYPELESS
  • R32G32B32A32_FLOAT
  • R32G32B32A32_UINT
  • R32G32B32A32_SINT
  • R32G32B32_TYPELESS
  • R32G32B32_FLOAT
  • R32G32B32_UINT
  • R32G32B32_SINT
  • R16G16B16A16_TYPELESS
  • R16G16B16A16_FLOAT
  • R16G16B16A16_UNORM
  • R16G16B16A16_UINT
  • R16G16B16A16_SNORM
  • R16G16B16A16_SINT
  • R32G32_TYPELESS
  • R32G32_FLOAT
  • R32G32_UINT
  • R32G32_SINT
  • R32G8X24_TYPELESS
  • D32_FLOAT_S8X24_UINT
  • R32_FLOAT_X8X24_TYPELESS
  • X32_TYPELESS_G8X24_UINT
  • R10G10B10A2_TYPELESS
  • R10G10B10A2_UNORM
  • R10G10B10A2_UINT
  • R11G11B10_FLOAT
  • R8G8B8A8_TYPELESS
  • R8G8B8A8_UNORM
  • R8G8B8A8_UNORM_SRGB
  • R8G8B8A8_UINT
  • R8G8B8A8_SNORM
  • R8G8B8A8_SINT
  • R16G16_TYPELESS
  • R16G16_FLOAT
  • R16G16_UNORM
  • R16G16_UINT
  • R16G16_SNORM
  • R16G16_SINT
  • R32_TYPELESS
  • D32_FLOAT
  • R32_FLOAT
  • R32_UINT
  • R32_SINT
  • R24G8_TYPELESS
  • D24_UNORM_S8_UINT
  • R24_UNORM_X8_TYPELESS
  • X24_TYPELESS_G8_UINT
  • R8G8_TYPELESS
  • R8G8_UNORM
  • R8G8_UINT
  • R8G8_SNORM
  • R8G8_SINT
  • R16_TYPELESS
  • R16_FLOAT
  • D16_UNORM
  • R16_UNORM
  • R16_UINT
  • R16_SNORM
  • R16_SINT
  • R8_TYPELESS
  • R8_UNORM
  • R8_UINT
  • R8_SNORM
  • R8_SINT
  • A8_UNORM
  • R1_UNORM
  • R9G9B9E5_SHAREDEXP
  • R8G8_B8G8_UNORM
  • G8R8_G8B8_UNORM
  • BC1_TYPELESS
  • BC1_UNORM
  • BC1_UNORM_SRGB
  • BC2_TYPELESS
  • BC2_UNORM
  • BC2_UNORM_SRGB
  • BC3_TYPELESS
  • BC3_UNORM
  • BC3_UNORM_SRGB
  • BC4_TYPELESS
  • BC4_UNORM
  • BC4_SNORM
  • BC5_TYPELESS
  • BC5_UNORM
  • BC5_SNORM
  • B5G6R5_UNORM
  • B5G5R5A1_UNORM
  • B8G8R8A8_UNORM
  • B8G8R8X8_UNORM
  • FORCE_UINT
enumSHADER_TYPE2 members

Methods

  • VERTEX_SHADER
  • PIXEL_SHADER
enuminternal2 members

Methods

  • BoundingBox
  • Frustum
classBuffer24 members

Methods

  • getElementByteSize()
  • getElementCount()
  • getTotalByteSize()
  • getUsage()
  • getBindFlag()
  • getCpuAccessFlag()
  • getMiscFlag()
  • setCpuData(arg0)
  • setCpuDataCopy(arg0)
  • setCpuDataForward(arg0)
  • freeCpuData()
  • setElementByteSize(arg0)
  • setElementCount(arg0)
  • copyParams(arg0)
  • setUsage(arg0)
  • setBindFlag(arg0)
  • setCpuAccessFlag(arg0)
  • setMiscFlag(arg0)
  • map(arg0)
  • unmap()
  • prepareForShaderResourceUsage(arg0)
  • prepareForComputeResourceUsage(arg0)
  • prepareForOutputStreamUsage(arg0)

Static methods

  • staticcreate(...args)
classBufferManager6 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • getByIndex(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classCamera43 members

Methods

  • getFrustum()
  • getName()
  • getPerspectiveFov()
  • getPerspectiveAspectRatio()
  • getPerspectiveOffCenterFovLeft()
  • getPerspectiveOffCenterFovRight()
  • getPerspectiveOffCenterFovTop()
  • getPerspectiveOffCenterFovBottom()
  • getOrthographicHeight()
  • getOrthographicAspectRatio()
  • getNear()
  • getFar()
  • getAutoUpdateOnContextSwitch()
  • getHidden()
  • getViewMatrix()+ getViewMatrix_u()
  • getProjectionMatrix()+ getProjectionMatrix_u()
  • getViewProjMatrix()+ getViewProjMatrix_u()
  • setPositionRelative(arg0)
  • setPositionAbsolute(arg0)
  • translateRelative(arg0)
  • translateAbsolute(arg0)
  • setOrientationRelative(arg0)
  • setOrientationAbsolute(arg0)
  • rotateRelative(arg0)
  • rotateAbsolute(arg0)
  • setAsPerspective(arg0, arg1)
  • setAsPerspectiveOffCenter(arg0, arg1, arg2, arg3)
  • setAsOrthographic(arg0, arg1)
  • setRange(arg0, arg1)
  • setAutoUpdateOnContextSwitch(arg0)
  • setHidden(arg0)
  • updateViewMatrix()
  • updateProjectionMatrix()
  • lookAt(...args)
  • getNearPlanePoints(arg0, arg1, arg2, arg3)
  • getFarPlanePoints(arg0, arg1, arg2, arg3)
  • getFrustumCornersDirectionsWorld(arg0, arg1, arg2, arg3)
  • getFrustumCornersDirectionsView(arg0, arg1, arg2, arg3)
  • getDirectionAtPixelWorld(...args)+ getDirectionAtPixelWorld_u()
  • getDirectionAtScreenCoordWorld(arg0, arg1)+ getDirectionAtScreenCoordWorld_u()
  • getDirectionAtPixelView(...args)+ getDirectionAtPixelView_u()
  • getDirectionAtScreenCoordView(arg0, arg1)+ getDirectionAtScreenCoordView_u()

Static methods

  • staticcreate(...args)
classCameraManager18 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • getByIndex(arg0)
  • rename(arg0, arg1)
  • erase(arg0)
  • getActiveRenderCamera()
  • getActiveCullingCamera()
  • getActiveLodCamera()
  • getDefaultCamera()
  • setActiveRenderCamera(arg0)
  • setActiveCullingCamera(arg0)
  • setActiveLodCamera(arg0)
  • setDefaultCamera(arg0)
  • resetRenderCameraToDefault()
  • resetCullingCameraToDefault()
  • resetLodCameraToDefault()
  • prepareForContext()

Static methods

  • staticgetInstance()
classCompositor12 members

Methods

  • addNode()
  • deleteNode(arg0)
  • changeNodeOrder(arg0, arg1)
  • clearNodes()
  • getNodeCount()
  • getNode(arg0)
  • getName()
  • getHidden()
  • setName(arg0)
  • setHidden(arg0)
  • renderChain()

Static methods

  • staticcreate(...args)
classCompositorManager10 members

Methods

  • getActiveCompositor()
  • getDefaultCompositor()
  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)
  • setActiveCompositor(arg0)
  • setDefaultCompositor(arg0)
  • prepareForContext(arg0)

Static methods

  • staticgetInstance()
classCompositorNode12 members

Methods

  • addOperations()
  • getOperations(arg0)
  • getOperationsCount()
  • deleteOperations(arg0)
  • changeOperationsOrder(arg0, arg1)
  • getName()
  • getParentCompositor()
  • getActive()
  • setName(arg0)
  • setParentCompositor()
  • setActive(arg0)
  • renderOperations()
classTargetOperations24 members

Methods

  • addClearTargetsPass(...args)
  • addMonoMaterialPass(...args)
  • addPostProcessPass(...args)
  • addRenderScenePass(...args)
  • getPassCount()
  • getPass(arg0)
  • deletePass(arg0)
  • changePassOrder(arg0, arg1)
  • setColorTarget(...args)
  • addColorTarget(arg0)
  • changeColorTargetOrder(arg0, arg1)
  • removeColorTarget(arg0)
  • setDepthTarget(arg0)
  • getColorTargetCount()
  • getColorTarget(arg0)
  • getColorTargetRenderIndex(arg0)
  • getDepthTarget()
  • setToBackBuffer(...args)
  • isToBackBuffer()
  • getBackBufferViewIndex()
  • setToChainDepthBuffer(arg0)
  • isToChainDepthBuffer()
  • setOverloadedViewport(arg0)
  • getOverloadedViewport()
classDecodedData1 member

Properties

  • _meshDatar/w
classDecodedMeshData0 members

No methods, properties or constructors are exposed through this binding.

classObjEncoder2 members

Static methods

  • staticcanDecode(buffer)
  • staticdecode(buffer, options)
classCompositeEncoder0 members

No methods, properties or constructors are exposed through this binding.

classEntity6 members

Methods

  • getParentNode()
  • getRenderQueue()
  • getUserData()
  • setRenderInfo(arg0)
  • setParentNode(arg0)
  • setUserData(arg0)
classNode30 members

Methods

  • setPositionRelative(arg0)
  • setPositionAbsolute(arg0)
  • translateRelative(arg0)
  • translateAbsolute(arg0)
  • getPositionRelative()+ getPositionRelative_u()
  • getPositionAbsolute()+ getPositionAbsolute_u()
  • setOrientationRelative(arg0)
  • setOrientationAbsolute(arg0)
  • rotateRelative(arg0)
  • rotateAbsolute(arg0)
  • getOrientationRelative()+ getOrientationRelative_u()
  • getOrientationAbsolute()+ getOrientationAbsolute_u()
  • setScaleRelative(arg0)
  • setScaleAbsolute(arg0)
  • applyScale(arg0)
  • getScaleRelative()+ getScaleRelative_u()
  • getScaleAbsolute()+ getScaleAbsolute_u()
  • getRelativeTransform()+ getRelativeTransform_u()
  • getAbsoluteTransform()+ getAbsoluteTransform_u()
  • updateTransformations()
  • dispatchDirtyTransform()
  • getAbsoluteUp()+ getAbsoluteUp_u()
  • getAbsoluteFront()+ getAbsoluteFront_u()
  • getAbsoluteRight()+ getAbsoluteRight_u()
  • getParentNode()
  • setParentNode(arg0)
  • getNumChildNode()
  • getHidden()
  • setHidden(arg0)

Static methods

  • staticcreate(...args)
classNodeManager5 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classMesh29 members

Methods

  • getBounds()
  • getVertexBuffer(arg0)
  • getVertexBufferStride(arg0)
  • getVertexBufferCount()
  • getIndexBuffer()
  • getInputLayout()
  • getId()
  • getVertexCount()
  • getIndexCount()
  • getTopology()
  • getIndexFormat()
  • getAutoComputeBounds()
  • setBounds(arg0)
  • addVertexBufferCopy(...args)
  • addVertexBufferForward(...args)
  • setIndexBufferCopy(...args)
  • setIndexBufferForward(...args)
  • setInputLayout(arg0)
  • setId(arg0)
  • setVertexCount(arg0)
  • setIndexCount(arg0)
  • setTopology(arg0)
  • setIndexFormat(arg0)
  • setAutoComputeBounds(arg0)
  • computeBounds(arg0)
  • load()
  • addVertexBuffer(buffer, stride)
  • setIndexBuffer(buffer)

Static methods

  • staticcreate(...args)
classMeshManager5 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classMeshUtils1 member

Static methods

  • staticfillMeshFromDecodedData(...args)
classClearTargetsPass7 members

Methods

  • setClearColor(arg0)
  • setColorTargetIndex(arg0)
  • setClearDepthValue(arg0)
  • setClearStencilValue(arg0)
  • setShouldClearColor(arg0)
  • setShouldClearDepth(arg0)
  • setShouldClearStencil(arg0)
classInstancingPass9 members

Methods

  • setToRender(arg0)
  • setInstanceNumber(arg0)
  • setShader(arg0)
  • setRenderCamera(arg0)
  • setCullingCamera(arg0)
  • setLodCamera(arg0)
  • setBlendState(arg0)
  • setRasterState(arg0)
  • setDepthStencilState()
classMonoMaterialPass1 member

Methods

  • setShader(arg0)
classPass2 members

Methods

  • getParent()
  • getType()
classPostProcessPass4 members

Methods

  • setShader(arg0)
  • setBackProcess(arg0)
  • setBlendState(arg0)
  • setCamera(arg0)
classRenderScenePass8 members

Methods

  • setRenderQueue(arg0)
  • setRenderCamera(arg0)
  • setCullingCamera(arg0)
  • setLodCamera(arg0)
  • setBlendState(arg0)
  • setRasterState(arg0)
  • setDepthStencilState()
  • setTransparentPass(arg0)
classProgram9 members

Methods

  • getLastCompilationResult()
  • isFromFile()
  • isFromMemory()
  • getMemory()
  • getId()
  • getType()
  • setFromMemory(arg0)
  • setActivateCrossCompilerDefines(arg0)

Static methods

  • staticcreate(...args)
classProgramCompilationResult3 members

Methods

  • getSuccess()
  • getErrorMessage()
  • getStage()
classProgramManager5 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classRenderContext11 members

Methods

  • getBackBuffer()
  • getDepthBuffer()
  • getViewport()
  • getCompositor()
  • getWidth()
  • getHeight()
  • isWindowFocused()
  • getAttachedWin()
  • getOwnsSurface()
  • setCompositor(arg0)
  • setGammaCorrected(arg0)
classRenderContextManager9 members

Methods

  • getRenderContextOf(arg0)
  • getActiveRenderContext()
  • getDefaultRenderContext()
  • createRenderContext(arg0)
  • eraseFor(arg0)
  • erase(arg0)
  • activateContextOf(arg0)
  • activateContext(arg0)

Static methods

  • staticgetInstance()
classRenderQueue8 members

Methods

  • getName()
  • getEntity(arg0)
  • getEntityCount()
  • getRenderStrategy()
  • addEntity()
  • eraseEntity(arg0)
  • clearQueue()

Static methods

  • staticcreate(...args)
classRenderQueueManager3 members

Methods

  • createOrRetrieve(arg0)

Static methods

  • staticgetInstance()
  • staticgetDefaultRenderQueueName()
classDefaultRenderStrategy8 members

Methods

  • getLodQualityFactor()
  • getFrustumCull()
  • getOrderQueue()
  • getUseLodSystem()
  • setLodQualityFactor(arg0)
  • setFrustumCull(arg0)
  • setOrderQueue(arg0)
  • setUseLodSystem(arg0)
classRenderStrategy1 member

Methods

  • asDefaultRenderStrategy()
classBlendState22 members

Methods

  • getAlphaToCoverageEnabled()
  • getIndependantBlendEnabled()
  • getTargetBlendEnabled(arg0)
  • getTargetSrcBlend(arg0)
  • getTargetDestBlend(arg0)
  • getTargetBlendOp(arg0)
  • getTargetSrcBlendAlpha(arg0)
  • getTargetDestBlendAlpha(arg0)
  • getTargetBlendOpAlpha(arg0)
  • getTargetWriteMask(arg0)
  • setAlphaToCoverageEnabled(arg0)
  • setIndependentBlendEnabled(arg0)
  • setTargetBlendEnable(arg0, arg1)
  • setTargetSrcBlend(arg0, arg1)
  • setTargetDestBlend(arg0, arg1)
  • setTargetBlendOp(arg0, arg1)
  • setTargetSrcBlendAlpha(arg0, arg1)
  • setTargetDestBlendAlpha(arg0, arg1)
  • setTargetBlendOpAlpha(arg0, arg1)
  • setTargetWriteMask(arg0, arg1)
  • resetToDefault()

Static methods

  • staticcreate(...args)
classBlendStateManager5 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classRasterState26 members

Methods

  • getFillMode()
  • getCullMode()
  • getFrontCounterClockwise()
  • getDepthBias()
  • getDepthBiasClamp()
  • getSlopeScaledDepthBias()
  • getDepthClipEnabled()
  • getScissorEnabled()
  • getMultiSampleEnabled()
  • getAntiAliasedLineEnabled()
  • getForcedSampleCount()
  • getConservativeRasterizationEnabled()
  • setFillMode(arg0)
  • setCullMode(arg0)
  • setFrontCounterClockwise(arg0)
  • setDepthBias(arg0)
  • setDepthBiasClamp(arg0)
  • setSlopeScaledDepthBias(arg0)
  • setDepthClipEnabled(arg0)
  • setScissorEnabled(arg0)
  • setMultiSampleEnabled(arg0)
  • setAntiAliasedLineEnabled(arg0)
  • setForcedSampleCount(arg0)
  • setConservativeRasterizationEnabled(arg0)
  • resetToDefault()

Static methods

  • staticcreate(...args)
classRasterStateManager5 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classResource12 members

Methods

  • load(...args)
  • unload()
  • isReadyForRendering()
  • isUnloaded()
  • getLoadState()
  • getPath()
  • getTypeName()
  • getName()
  • getHidden()
  • setPath(arg0)
  • setName(arg0)
  • setHidden(arg0)
classShaderResource0 members

No methods, properties or constructors are exposed through this binding.

classSampler28 members

Methods

  • getFiltering()
  • getAddressModeU()
  • getAddressModeV()
  • getAddressModeW()
  • getComparisonFunction()
  • getMipBias()
  • getMaxAnisotropy()
  • getMinLodLevel()
  • getMaxLodLevel()
  • getBorderColorR()
  • getBorderColorG()
  • getBorderColorB()
  • getBorderColorA()
  • setBorderColors(arg0, arg1, arg2, arg3)
  • setBorderColorR(arg0)
  • setBorderColorG(arg0)
  • setBorderColorB(arg0)
  • setBorderColorA(arg0)
  • setLodLevels(arg0, arg1)
  • setMaxAnisotropy(arg0)
  • setMipMapBias(arg0)
  • setFilterMethod(arg0)
  • setAddressModeU(arg0)
  • setAddressModeV(arg0)
  • setAddressModeW(arg0)
  • setComparisonFunction(arg0)
  • resetToDefault()

Static methods

  • staticcreate(...args)
classSamplerManager2 members

Methods

  • createOrRetrieve(arg0)

Static methods

  • staticgetInstance()
classConstantBuffer5 members

Methods

  • getPassMemorySlot(arg0)
  • getPassMemorySlotReadOnly(arg0)
  • addPassMemorySlot()
  • changePassMemorySlotOrder(arg0, arg1)
  • deletePassMemorySlot(arg0)
classShaderInstanceCustomSlot7 members

Methods

  • getTypeName()
  • getSemanticName()
  • setSemanticName(arg0)
  • getDataByteSize()
  • fillDataBuffer()

Static methods

  • staticimplement(arg0)
  • staticextend(arg0, arg1)
classShaderMemorySlot2 members

Methods

  • getSlotType()
  • getDataTypeAsString()
classShader35 members

Methods

  • getId()
  • isUsableScene()
  • isUsablePostProcess()
  • isUsableCompute()
  • isUsableGeometry()
  • isUsableRaytracing()
  • getProgram()
  • getMaxInstancePerBuffer()
  • getIsBuiltInShader()
  • getDirtyInstanceData()
  • setProgram(arg0)
  • setId(arg0)
  • setMaxInstancePerBuffer(arg0)
  • setDirtyInstanceData(arg0)
  • reset()
  • addConstantBuffer(...args)
  • getConstantBuffer(...args)
  • changeConstantBufferSlot(...args)
  • deleteConstantBuffer(...args)
  • addTexture(...args)
  • getTexture(...args)
  • setTexture(...args)
  • changeTextureSlot(...args)
  • forgetTexture(...args)
  • addSampler(...args)
  • getSampler(...args)
  • setSampler(...args)
  • changeSamplerSlot(...args)
  • forgetSampler(...args)
  • addInstanceMemorySlot()
  • getInstanceMemorySlot(arg0)
  • getInstanceMemorySlotReadOnly(arg0)
  • changeInstanceMemorySlotOrder(arg0, arg1)
  • deleteInstanceMemorySlot(arg0)

Static methods

  • staticcreate(...args)
classShaderManager5 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classSystem12 members

Constructors

  • System()

Methods

  • getIsInitialized()
  • getHasRunToContinue()
  • setHasRunToContinue(arg0)
  • initialize(...args)
  • kill()
  • shutdown()
  • frame(...args)
  • tickForNewFrame(arg0)

Static methods

  • staticgetInstance()
  • staticgetInstanceIfExisting()
  • statickill()
classTexture30 members

Methods

  • isGammaCorrected()
  • isBackBufferTex()
  • getTexType()
  • getRenderFlag()
  • getNeededMipsForSize()
  • getWidth()
  • getHeight()
  • getDepthOrArraySize()
  • getMipLevels()
  • getTextureFormat()
  • getSampleCount()
  • getSampleQuality()
  • getAutoMipGeneration()
  • addCpuDataSlice(arg0, arg1, arg2, arg3)
  • addCpuDataSliceCopy(arg0, arg1, arg2, arg3)
  • addCpuDataSliceForward(arg0, arg1, arg2, arg3)
  • addCpuDataSliceRelativeToLast(arg0, arg1, arg2)
  • setFromImage(arg0)
  • setFromImageCopy(arg0)
  • setFromImageForward(arg0)
  • setGammaCorrected(arg0)
  • setWidth(arg0)
  • setHeight(arg0)
  • setDepthOrArraySize(arg0)
  • setMipLevels(arg0)
  • setTextureFormat(arg0)
  • setAutoMipGeneration(arg0)
  • setRenderFlag(arg0)
  • convertToImage(arg0, arg1)

Static methods

  • staticcreate(...args)
classTextureManager9 members

Methods

  • createOrRetrieve(arg0)
  • get(arg0)
  • rename(arg0, arg1)
  • erase(arg0)
  • setActiveRenderTarget(arg0)
  • setActiveDepthTarget(arg0)
  • getActiveRenderTarget()
  • getDepthTarget()

Static methods

  • staticgetInstance()
classTextureUtils13 members

Static methods

  • staticgetFormatByteSize(arg0)
  • staticgetFormatChannelCount(arg0)
  • staticgetFormatSrgbEquivalent(arg0)
  • staticgetFormatRgbEquivalent(arg0)
  • staticgetFormatTypelessEquivalent(arg0)
  • staticgetFormatDepthEquivalent(arg0)
  • staticgetFormatUncompressedEquivalent(arg0)
  • staticgetFormatWithAlphaEquivalent(arg0)
  • staticisFormatOver255(arg0)
  • staticisFormatCompressed(arg0)
  • staticisFormatCompatibleForRenderFlag(arg0, arg1, arg2)
  • staticgetNeededMipsForSize(arg0, arg1, arg2, arg3)
  • staticgetFormatFromImageFormat(arg0)
classViewport16 members

Methods

  • getWidth()
  • getHeight()
  • getMinDepth()
  • getMaxDepth()
  • getTopLeftX()
  • getTopLeftY()
  • getName()
  • getDirtyViewport()
  • setWidth(arg0)
  • setHeight(arg0)
  • setMinDepth(arg0)
  • setMaxDepth(arg0)
  • setTopLeftX(arg0)
  • setTopLeftY(arg0)
  • setName(arg0)
  • setDirtyViewport(arg0)
classViewportManager8 members

Methods

  • getActiveViewport()
  • setActiveViewport(arg0)
  • createOrRetrieve(arg0)
  • get(arg0)
  • getByIndex(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classBoundingBoxmanaged + unmanaged13 members

Constructors

  • BoundingBox()
  • BoundingBox(a, b)

Properties

  • _pointsr/w= [new nkMaths.Vector,new nkMaths.Vector,new nkMaths.Vector…
  • _transformedPointsr/w= [new nkMaths.Vector,new nkMaths.Vector,new nkMaths.Vector…

Methods

  • getPoints()
  • getTransformedPoints()
  • getCenter()
  • getAxisAlignedSides()
  • getMin()
  • getMax()
  • setPoints(points)
  • updateTransformation(node)
  • checkAgainst(frustum)
classFrustummanaged + unmanaged6 members

Constructors

  • Frustum()
  • Frustum(a)

Properties

  • _planesreadonly= [new nkMaths.Vector,new nkMaths.Vector,new nkMaths.Vector…

Methods

  • getPlane(index)
  • setPlane(plane, index)
  • buildFrustum(viewMat, projMat)
classTargetDescriptormanaged + unmanaged7 members

Constructors

  • TargetDescriptor()
  • TargetDescriptor(a)
  • TargetDescriptor(a, b)
  • TargetDescriptor(a, b, c)

Properties

  • _targetreadonly= null
  • _indexInTextureArrayreadonly= 0
  • _mipIndexreadonly= 0
classConfigurationmanaged + unmanaged2 members

Constructors

  • Configuration()

Properties

  • _wantedApireadonly= nkGraphics.RENDERING_API.AUTOMATIC}_toUnmanaged(targetNkI…
classObjDecodeOptions4 members

Constructors

  • ObjDecodeOptions()

Properties

  • _objSpacereadonly= nkGraphics.OBJ_SPACE.UP_Y_FRONT_Z
  • _invertUvYreadonly= false
  • _invertWindingOrderreadonly= false}}
classEntityRenderInfomanaged + unmanaged8 members

Constructors

  • EntityRenderInfo()
  • EntityRenderInfo(a, b)

Properties

  • _slotsreadonly= []
  • _parentEntityreadonly= null

Methods

  • getSlot(index)
  • getParentEntity()
  • addSlot(slot)
  • eraseSlot(index)
classEntityRenderInfoSlotmanaged + unmanaged8 members

Constructors

  • EntityRenderInfoSlot()
  • EntityRenderInfoSlot(a, b)

Properties

  • _lodsreadonly= []
  • _parentEntityreadonly= null

Methods

  • getLod(index)
  • getParentEntity()
  • addLod(lod)
  • eraseLod(index)
classEntityRenderLodSlotmanaged + unmanaged17 members

Constructors

  • EntityRenderLodSlot()
  • EntityRenderLodSlot(a, b)

Properties

  • _meshreadonly= null
  • _shaderreadonly= null
  • _activeShaderreadonly= null
  • _parentSlotreadonly= null
  • _parentEntityreadonly= null
  • _qualityMetricreadonly= 0

Methods

  • getMesh()
  • getShader()
  • getQualityMetric()
  • getActiveShader()
  • getParentSlot()
  • getParentEntity()
  • setMesh(value)
  • setShader(value)
  • setQualityMetric(value)
classMeshInputLayoutmanaged + unmanaged18 members

Constructors

  • MeshInputLayout()

Properties

  • _attributesreadonly= []
  • _positionAttributeNamereadonly= "POSITION"
  • _normalAttributeNamereadonly= "NORMAL"
  • _texCoordAttributeNamereadonly= "TEXCOORD"

Methods

  • getPositionAttributeName()
  • getNormalAttributeName()
  • getTexCoordAttributeName()
  • setAttribute(attribute, index)
  • setPositionAttributeName(value)
  • setNormalAttributeName(value)
  • setTexCoordAttributeName(value)
  • addAttribute(attribute)
  • getAttribute(indexOrName)
  • getAttributeCount()
  • removeAttribute(indexOrName)
  • hasAttribute(name)

Static methods

  • staticcopy(dest, source)
classMeshInputLayoutAttributemanaged + unmanaged9 members

Constructors

  • MeshInputLayoutAttribute()
  • MeshInputLayoutAttribute(a)

Properties

  • _semanticNamer/w= ""
  • _bufferSlotr/w= 0
  • _byteOffsetr/w= -1
  • _instanceStepRater/w= 1
  • _arraySizer/w= 1
  • _formatr/w= nkGraphics.FORMAT.R32G32B32A32_FLOAT
  • _granularityr/w= nkGraphics.ATTRIBUTE_GRANULARITY.PER_VERTEX
classMeshFillOptionsmanaged + unmanaged3 members

Constructors

  • MeshFillOptions()

Properties

  • _dataFillTyper/w= nkGraphics.DATA_FILL_TYPE.FORWARD
  • _autoLoadr/w= true}_toUnmanaged(targetNkId){const result=new nkGraphics…
classProgramSourcesHoldermanaged + unmanaged11 members

Constructors

  • ProgramSourcesHolder()

Properties

  • _vertexMemoryreadonly= ""
  • _pixelMemoryreadonly= ""
  • _macrosVertexreadonly= []
  • _macrosPixelreadonly= []}getVertexMemory(){return this._vertexMemory}getPixelMe…

Methods

  • getVertexMemory()
  • getPixelMemory()
  • setVertexMemory(sources)
  • setPixelMemory(sources)
  • addDefineMacroVertex(key, value)
  • addDefineMacroPixel(key, value)
classRenderContextDescriptormanaged + unmanaged7 members

Constructors

  • RenderContextDescriptor()
  • RenderContextDescriptor(a, b, c)

Properties

  • _widthreadonly= 1
  • _heightreadonly= 1
  • _windowreadonly= null
  • _texturereadonly= null
  • _offscreenContextreadonly= false
nkImages

nkImages

Image data and encoding

Automatically generated at build time from the shipped engine giving the complete in-scope API.

enumALPHA_MODE3 members

Methods

  • AUTO
  • NO_ALPHA
  • ALPHA
enumPIXEL_FORMAT19 members

Methods

  • UNKNOWN_FORMAT
  • R8
  • R8A8
  • R8G8B8
  • R8G8B8A8
  • B8G8R8
  • B8G8R8A8
  • R16G16B16A16
  • R32G32B32
  • R32G32B32A32
  • Y8U8V8_444
  • Y8U8Y8V8_422
  • Y8U8V8_420_SP
  • Y8Y8U8Y8Y8V8_411
  • BC1
  • BC2
  • BC3
  • BC4
  • BC5
classBmpEncoder4 members

Static methods

  • staticencode(arg0)
  • staticencodeBase(arg0)
  • staticcanDecode(arg0)
  • staticdecode(...args)
classDdsEncoder3 members

Static methods

  • staticencode(arg0)
  • staticcanDecode(arg0)
  • staticdecode(...args)
classPixelFormatUtils4 members

Static methods

  • staticgetFormatByteSize(arg0)
  • staticisFormatCompressed(arg0)
  • staticisFormatFloatingPoint(arg0)
  • statichasAlpha(arg0)
classHdrEncoder3 members

Static methods

  • staticencode(arg0)
  • staticcanDecode(arg0)
  • staticdecode(...args)
classJpgEncoder3 members

Static methods

  • staticencode()
  • staticcanDecode(arg0)
  • staticdecode(...args)
classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classCompositeEncoder2 members

Static methods

  • staticcanDecode(arg0)
  • staticdecode(...args)
classAlignmentDescriptor6 members

Constructors

  • AlignmentDescriptor()

Properties

  • _rowByteAlignmentreadonly= 1
  • _pixelByteAlignmentreadonly= 1
  • _alphaModereadonly= nkImages.ALPHA_MODE.AUTO
  • _forceRgbFormatreadonly= true
  • _forceRgbReorderingreadonly= false}}
classImagemanaged + unmanaged23 members

Constructors

  • Image()
  • Image(a)
  • Image(a, b, c, d, e, f)

Properties

  • _basereadonly= new nkImages.ImageBase(...argArray.slice(1))

Methods

  • getWidth(mip)
  • getHeight(mip)
  • getDepthOrArraySize(mip)
  • getMipCount()
  • getFormat()
  • getPixelByteSize()
  • getRowByteSize(mip=0)
  • getSliceByteSize(mip=0)
  • getAlphaPremultiplied()
  • getCubeMap()
  • isArray()
  • setFormat(value)
  • setPixelOrBlockByteSize(value)
  • setAlphaPremultiplied(value)
  • setCubeMap(value)
  • getPixel(x, y, z=0, mip=0)+ getPixel_u()
  • getDataByteSize()
  • getDataBuffer()
  • isView()
classImageBasemanaged + unmanaged24 members

Constructors

  • ImageBase()
  • ImageBase()

Properties

  • _datareadonly= null
  • _imagesreadonly= []
  • _formatreadonly= nkImages.PIXEL_FORMAT.UNKNOWN_FORMAT
  • _pixelOrBlockByteSizereadonly= 0
  • _alphaPremultipliedreadonly= false
  • _cubeMapreadonly= false

Methods

  • getWidth(mip=0)
  • getHeight(mip=0)
  • getDepthOrArraySize(mip=0)
  • getMipCount()
  • getFormat()
  • getPixelByteSize()
  • getRowByteSize(mip=0)
  • getSliceByteSize(mip=0)
  • getAlphaPremultiplied()
  • getCubeMap()
  • isArray()
  • setFormat(value)
  • setPixelOrBlockByteSize(value)
  • setAlphaPremultiplied(value)
  • setCubeMap(value)
  • getPixel(x, y, z=0, mip=0)+ getPixel_u()
classImageDescriptormanaged + unmanaged8 members

Constructors

  • ImageDescriptor()
  • ImageDescriptor(a)
  • ImageDescriptor(a, b)

Properties

  • _mipsr/w= []
  • _mipOffsetsr/w= []

Methods

  • getMip(index)
  • getMipOffset(index)
  • addMip(mip, mipOffset)
classMipDescriptormanaged + unmanaged15 members

Constructors

  • MipDescriptor()
  • MipDescriptor(a)
  • MipDescriptor(a, b, c, d, e, f)

Properties

  • _widthr/w= 0
  • _heightr/w= 0
  • _depthr/w= 0
  • _rowByteSizer/w= 0
  • _sliceByteSizer/w= 0
  • _fullByteSizer/w= 0

Methods

  • getWidth()
  • getHeight()
  • getDepth()
  • getRowByteSize()
  • getSliceByteSize()
  • getFullByteSize()
nkLog

nkLog

Loggers and log receivers

Automatically generated at build time from the shipped engine giving the complete in-scope API.

classConsoleLogger2 members

Constructors

  • ConsoleLogger()

Methods

  • log(arg0, arg1)
classLogger0 members

No methods, properties or constructors are exposed through this binding.

nkDebug

nkDebug

Testing framework and diagnostics

Automatically generated at build time from the shipped engine giving the complete in-scope API.

classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classTestRunResult4 members

Constructors

  • TestRunResult()
  • TestRunResult(a)

Methods

  • getRejectionReason()
  • getSuccess()
classConsoleOutputFormatter3 members

Constructors

  • ConsoleOutputFormatter()

Static methods

  • staticimplement(arg0)
  • staticextend(arg0, arg1)
classNunitOutputFormatter3 members

Constructors

  • NunitOutputFormatter()

Static methods

  • staticimplement(arg0)
  • staticextend(arg0, arg1)
classDefaultTestObserver3 members

Constructors

  • DefaultTestObserver()

Static methods

  • staticimplement(arg0)
  • staticextend(arg0, arg1)
classTestClassObserverInformation7 members

Constructors

  • TestClassObserverInformation()

Methods

  • getName()
  • getClassTotalFunctionCount()
  • getClassFilteredFunctionCount()
  • setName(arg0)
  • setClassTotalFunctionCount(arg0)
  • setClassFilteredFunctionCount(arg0)
classTestFunctionObserverInformation7 members

Constructors

  • TestFunctionObserverInformation()

Methods

  • getName()
  • getTimeMicroS()
  • getRunResult()
  • setName(arg0)
  • setTimeMicroS(arg0)
  • setRunResult(arg0)
classTestRunParameters7 members

Constructors

  • TestRunParameters()

Methods

  • getClassNameFilter()
  • getFunctionNameFilter()
  • getObserver()
  • setClassNameFilter(arg0)
  • setFunctionNameFilter(arg0)
  • setObserver(arg0)
classFunctionSet6 members

Constructors

  • FunctionSet()

Properties

  • _functionsreadonly= []}getTestFunction(index){if(index<this._functions.length…

Methods

  • getTestFunction(index)
  • getTestFunctions(filter)
  • getSetSize()
  • registerFunction(name, func)
classTestClass6 members

Methods

  • getFunctionSet()
  • setClassInitFunction(f)
  • setClassShutdownFunction(f)
  • setTestFunctionInitFunction(f)
  • setTestFunctionShutdownFunction(f)
  • execute(parameters)
classTestFunction7 members

Constructors

  • TestFunction(a, b)

Properties

  • _namereadonly= name
  • _functionreadonly= func
  • _isAsyncreadonly= func.constructor.name=="AsyncFunction"}getName(){return t…

Methods

  • getName()
  • getFunction()
  • getIsAsync()
classTestUtils7 members

Static methods

  • staticcheck(c, m="")
  • staticareNumbersEqual(a, b, p=0, m="")
  • staticareStringsEqual(a, b, m="")
  • staticareNumbersNotEqual(a, b, p=0, m="")
  • staticareStringsNotEqual(a, b, m="")
  • staticisNull(a, m="")
  • staticisNotNull(a, m="")
constUnitTesterRun = false
classUnitTester1 member

Static methods

  • staticrun(parameters)
classTestRunException5 members

Constructors

  • TestRunException(a)

Properties

  • _rejectionReasonreadonly= ""
  • _rejectionStackreadonly= []

Methods

  • getRejectionReason()
  • getRejectionStack()
classTestStackLevel7 members

Constructors

  • TestStackLevel(a, b)

Properties

  • _functionNamereadonly= typeof functionName==="string"?functionName:""
  • _linereadonly= typeof line==="number"?line:0}getFunctionName(){return th…

Methods

  • getFunctionName()
  • getLine()
  • setFunctionName(value)
  • setLine(value)
classOutputFormatter9 members

Methods

  • formatRunLaunch(params)
  • formatRunEnd()
  • formatClassLaunch(info)
  • formatClassBypass(info)
  • formatClassEnd(info)
  • formatTestLaunch(info)
  • formatTestBypass(info)
  • formatTestSuccess(info)
  • formatTestFailure(info)
classTestObserver9 members

Methods

  • onRunLaunch(params)
  • onRunEnd()
  • onClassLaunch(info)
  • onClassBypass(info)
  • onClassEnd(info)
  • onTestLaunch(info)
  • onTestBypass(info)
  • onTestSuccess(info)
  • onTestFailure(info)
nkWinUi

nkWinUi

System and UI components

Automatically generated at build time from the shipped engine giving the complete in-scope API.

enumCOMPONENT_TYPE2 members

Methods

  • STATIC
  • WINDOW
classComponent49 members

Methods

  • getDomElement()
  • getPositionInParent()+ getPositionInParent_u()
  • getPositionInScreen()+ getPositionInScreen_u()
  • getWidth()
  • getHeight()
  • isInitialized()
  • getSystem()
  • getParentComponent()
  • getComponentType()
  • getComponentName()
  • getVisibility()
  • getLabel()
  • isEnabled()
  • isForegroundWindow()
  • getZDepth()
  • getVisibleOnLoad()
  • setPositionInParent(arg0)
  • setPositionInScreen(arg0)
  • setSize(arg0, arg1)
  • setWidth(arg0)
  • setHeight(arg0)
  • setMinSize(arg0, arg1)
  • setMaxSize(arg0, arg1)
  • setRatio(arg0)
  • setParentComponent(...args)
  • setLabel(arg0)
  • setComponentName(arg0)
  • setVisibility(arg0)
  • setEnabled(arg0)
  • setVisibleOnLoad(arg0)
  • addChild(...args)
  • removeChild(arg0)
  • getChild(arg0)
  • getChildIndex(arg0)
  • unloadWithChildren()
  • loadWithChildren()
  • updateZDepth()
  • bringToForeground()
  • focusWindow()
  • getCoordRelativeFromAbsolute(arg0)+ getCoordRelativeFromAbsolute_u()
  • getCoordAbsoluteFromRelative(arg0)+ getCoordAbsoluteFromRelative_u()
  • load()
  • unload()
  • reload()
  • updateWindow()
  • asWindow()
  • cloneWithComputedStyles(src)
  • packImagesIntoBase64(src)
  • paintToImage()
classComponentManager6 members

Methods

  • createOrRetrieve(arg0, arg1)
  • get(arg0)
  • getByIndex(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classStatic4 members

Methods

  • getDomElement()
  • getWordWrap()
  • setWordWrap(arg0)

Static methods

  • staticcreate(...args)
classWindow3 members

Methods

  • getCanvasName()
  • getDomElement()
  • setFromExternalCanvas(canvas)
classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classSystem8 members

Constructors

  • System()

Methods

  • getComponentManager()
  • initialize()
  • tick()
  • prepareForShutdown()
  • shutdown()

Static methods

  • staticgetInstance()
  • statickill()
enumjsDom1 member

Methods

  • JsDomEventDispatcher
nkExport

nkExport

Utilities (e.g. Base64 encoding)

Automatically generated at build time from the shipped engine giving the complete in-scope API.

classBase64Encoder2 members

Static methods

  • staticencode(...args)
  • staticdecode(...args)
nkAstraeus

nkAstraeus

Effects

Automatically generated at build time from the shipped engine giving the complete in-scope API.

enumBLUR_TYPE1 member

Methods

  • GAUSSIAN
enumCOMPLEX_EFFECT_TYPE3 members

Methods

  • UNKNOWN
  • BLUR
  • DOF
enumEFFECT_TYPE8 members

Methods

  • UNKNOWN
  • ATMOSPHERE
  • FILM_GRAIN
  • FXAA
  • IMAGE_ENVIRONMENT
  • SSAO
  • TEXTURE_COPY
  • TONE_MAPPING
enumFXAA_PRESET17 members

Methods

  • DITHER_MEDIUM_RADIUS_3
  • DITHER_MEDIUM_RADIUS_4
  • DITHER_MEDIUM_RADIUS_5
  • DITHER_MEDIUM_RADIUS_6
  • DITHER_MEDIUM_RADIUS_7
  • DITHER_MEDIUM_RADIUS_8
  • DITHER_LOW_RADIUS_3
  • DITHER_LOW_RADIUS_4
  • DITHER_LOW_RADIUS_5
  • DITHER_LOW_RADIUS_6
  • DITHER_LOW_RADIUS_7
  • DITHER_LOW_RADIUS_8
  • DITHER_LOW_RADIUS_9
  • DITHER_LOW_RADIUS_10
  • DITHER_LOW_RADIUS_11
  • DITHER_LOW_RADIUS_12
  • DITHER_LOWEST_RADIUS_12
enumIMAGE_ENVIRONMENT_PROJECTION4 members

Methods

  • AUTO
  • FLAT
  • CUBE
  • EQUIRECTANGULAR
enumONE_CHANNEL_PACK4 members

Methods

  • R
  • G
  • B
  • A
enumTHREE_CHANNEL_PACK7 members

Methods

  • RGB
  • RGA
  • RBA
  • GBA
  • BGR
  • BGA
  • BRA
enumMATERIAL_TYPE2 members

Methods

  • UNKNOWN
  • PBS
classBlurComplexEffect9 members

Methods

  • getSourceTexture()
  • getOutputTexture()
  • getKernelRadius()
  • getAlphaEncodesBlurPlanes()
  • getPreserveAlpha()
  • setSourceTexture(arg0)
  • setKernelRadius(arg0)
  • setAlphaEncodesBlurPlanes(arg0)
  • setPreserveAlpha(arg0)
classComplexEffect6 members

Methods

  • getName()
  • getShader()
  • getType()
  • setCompositorNode(arg0)
  • load()
  • unload()
classComplexEffectManager2 members

Methods

  • createOrRetrieve(arg0, arg1)

Static methods

  • staticgetInstance()
classComplexEffectTypeUtils2 members

Static methods

  • staticenumToString(arg0)
  • staticstringToEnum(arg0)
classDofComplexEffect19 members

Methods

  • getSourceTexture()
  • getSourceDepth()
  • getOutputTexture()
  • getCamera()
  • getNearPlaneDistance()
  • getFocalPlaneDistance()
  • getFocalPlaneThickness()
  • getFarPlaneDistance()
  • getBlurStrength()
  • getLinearDepth()
  • setSourceTexture(arg0)
  • setSourceDepth(arg0)
  • setCamera(arg0)
  • setNearPlaneDistance(arg0)
  • setFocalPlaneDistance(arg0)
  • setFocalPlaneThickness(arg0)
  • setFarPlaneDistance(arg0)
  • setBlurStrength(arg0)
  • setLinearDepth(arg0)
classAtmosphereEffect42 members

Methods

  • getSunTransmittanceLut()
  • getMultiScatteringLut()
  • getSourceColorTexture()
  • getSourceDepthTexture()
  • getLutShader()
  • setSourceColorTexture(arg0)
  • setSourceDepthTexture(arg0)
  • setSunPosition(arg0)
  • setPlanetAlbedo(arg0)
  • setRayleighScattering(arg0)
  • setRayleighExtinction(arg0)
  • setRayleighAbsorb(arg0)
  • setMieScattering(arg0)
  • setMieExtinction(arg0)
  • setMieAbsorb(arg0)
  • setOzoneScattering(arg0)
  • setOzoneExtinction(arg0)
  • setOzoneAbsorb(arg0)
  • setMieG(arg0)
  • setRayleighHeightDensityFactor(arg0)
  • setMieHeightDensityFactor(arg0)
  • setOzoneHeightDensityFactor(arg0)
  • setDistanceFactor(arg0)
  • setSunIlluminanceFactor(arg0)
  • setSunAngularRadius(arg0)
  • setSunTransmittanceLutSampleCount(arg0)
  • setMultiScatteringLutSphereSampleCount(arg0)
  • setMultiScatteringLutMarchSampleCount(arg0)
  • setRaymarchSampleCount(arg0)
  • setShadowSource()
  • setShadowDepthBias(arg0)
  • setShadowDebug(arg0)
  • setSunTransmittanceLutWidth(arg0)
  • setSunTransmittanceLutHeight(arg0)
  • setMultiScatteringLutWidth(arg0)
  • setMultiScatteringLutHeight(arg0)
  • setUseHalfFloatForLuts(arg0)
  • setOnlyScatterOnObjects(arg0)
  • setDisplaySun(arg0)
  • setReverseZ(arg0)
  • setDebugNumericalInstability(arg0)
  • refreshLuts()
classEffect5 members

Methods

  • getName()
  • getShader()
  • getType()
  • load()
  • unload()
classEffectManager2 members

Methods

  • createOrRetrieve(arg0, arg1)

Static methods

  • staticgetInstance()
classFilmGrainEffect8 members

Methods

  • getSourceTexture()
  • getStrength()
  • getRgbNoise()
  • getBlendGrainInTarget()
  • setSourceTexture(arg0)
  • setStrength(arg0)
  • setRgbNoise(arg0)
  • setBlendGrainInTarget(arg0)
classFilmGrainEffectUtils1 member

Static methods

  • staticprepareBlendStateForGrainBlending(arg0)
classFxaaEffect12 members

Methods

  • getSourceTexture()
  • getMinContrast()
  • getMinLuminance()
  • getSmoothingStrength()
  • getPreset()
  • getLuminanceAsGreenChannelOnly()
  • setSourceTexture(arg0)
  • setMinContrast(arg0)
  • setMinLuminance(arg0)
  • setSmoothingStrength(arg0)
  • setPreset(arg0)
  • setLuminanceAsGreenChannelOnly(arg0)
classImageEnvironmentEffect8 members

Methods

  • getSourceTexture()
  • getSourceSampler()
  • getSourceCamera()
  • getSourceProjection()
  • setSourceTexture(arg0)
  • setSourceSampler(arg0)
  • setSourceCamera(arg0)
  • setSourceProjection(arg0)
classSsaoEffect20 members

Methods

  • getPositionBuffer()
  • getNormalBuffer()
  • getDepthBuffer()
  • getLinearDepth()
  • getCamera()
  • getSamplingRadius()
  • getMaxOcclusionDistance()
  • getStrength()
  • getDepthBias()
  • getKernelSampleCount()
  • getOcclusionDrivesAlpha()
  • setEffectFromGBufferInfo(...args)
  • setEffectFromDepthInfo(...args)
  • setCamera(arg0)
  • setSamplingRadius(arg0)
  • setMaxOcclusionDistance(arg0)
  • setStrength(arg0)
  • setDepthBias(arg0)
  • setKernelSampleCount(arg0)
  • setOcclusionDrivesAlpha(arg0)
classSsaoEffectUtils1 member

Static methods

  • staticprepareBlendStateForAoBlending(arg0)
classTextureCopyEffect4 members

Methods

  • getSourceTexture()
  • getSourceSampler()
  • setSourceTexture(arg0)
  • setSourceSampler(arg0)
classToneMappingEffect12 members

Methods

  • getSourceTexture()
  • getReinhardUsed()
  • getReinhardMaxWhite()
  • getHablesUsed()
  • getHablesDescriptor()
  • getAcesUsed()
  • getAcesLookTransform()
  • setSourceTexture(arg0)
  • setAsReinhard(...args)
  • setAsHables(...args)
  • setAsAces(...args)
  • setUseLuminance(arg0)
classMaterial5 members

Methods

  • getName()
  • getShader()
  • getType()
  • load()
  • unload()
classMaterialManager6 members

Methods

  • createOrRetrieve(arg0, arg1)
  • get(arg0)
  • getByIndex(arg0)
  • rename(arg0, arg1)
  • erase(arg0)

Static methods

  • staticgetInstance()
classMaterialTypeUtils2 members

Static methods

  • staticenumToString(arg0)
  • staticstringToEnum(arg0)
classPbsMaterial18 members

Methods

  • setLightDirection(arg0)
  • setLightColor(arg0)
  • setAlbedoColor(arg0)
  • setSpecularColor(arg0)
  • setEmissiveColor(arg0)
  • setEnvironmentColor(arg0)
  • setMetalness(arg0)
  • setRoughnessGlossiness(arg0)
  • setAlbedoTexture(...args)
  • setSpecularTexture(...args)
  • setEmissiveTexture(...args)
  • setMetalnessTexture(...args)
  • setRoughnessGlossinessTexture(...args)
  • setNormalMapTexture(...args)
  • setEnvironmentTexture(...args)
  • setIrradianceTexture(...args)
  • setEnvironmentTextureIsCubeByDefault(arg0)
  • setIrradianceTextureIsCubeByDefault(arg0)
classPbsEnvironmentMapFilter2 members

Methods

  • requestEnvironmentMapFiltering(...args)
  • requestIrradianceComputing(arg0, arg1)
classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classSystem7 members

Constructors

  • System()

Methods

  • initialize(...args)
  • kill()
  • shutdown()

Static methods

  • staticgetInstance()
  • staticgetInstanceIfExisting()
  • statickill()
nkSounds

nkSounds

enumAUDIO_ERROR7 members

Methods

  • NONE
  • FORMAT_NOT_SUPPORTED
  • DEVICE_UNAVAILABLE
  • BUFFER_UNDERRUN
  • DECODER_ERROR
  • OUT_OF_MEMORY
  • UNKNOWN
enumAUDIO_FORMAT4 members

Methods

  • UNKNOWN
  • PCM_FLOAT32
  • PCM_INT16
  • PCM_INT24
enumCHANNEL_LAYOUT5 members

Methods

  • UNKNOWN
  • MONO
  • STEREO
  • SURROUND_5_1
  • SURROUND_7_1
enumSOUND_LOAD_MODE3 members

Methods

  • DECODED
  • COMPRESSED
  • STREAMED
classSound9 members

Constructors

  • Sound()

Methods

  • setSource(arg0)
  • setLoadMode(arg0)
  • load()
  • getLoadMode()
  • getSourceFormat()
  • getChannelCount()
  • getSampleRate()
  • getTotalFrames()
classAudioEffect2 members

Methods

  • isActive()
  • setActive(arg0)
classBus9 members

Constructors

  • Bus(a, b, c, d)

Methods

  • getChannelLayout()
  • getSampleRate()
  • getBlockSize()
  • addSource(arg0, arg1)
  • removeSource(arg0)
  • setSourceGain(arg0, arg1)
  • addEffect(arg0)
  • removeEffect(arg0)
classAudioSource0 members

No methods, properties or constructors are exposed through this binding.

classSoundInstance10 members

Constructors

  • SoundInstance(a, b)

Methods

  • getLoop()
  • setLoop(arg0)
  • getPitch()
  • setPitch(arg0)
  • getPan()
  • setPan(arg0)
  • fadeTo(arg0, arg1)
  • isFading()
  • isFinished()
classSystem7 members

Constructors

  • System()

Methods

  • initialize()
  • tick()
  • shutdown()
  • getMixer()

Static methods

  • staticgetInstance()
  • statickill()
nkTasks

nkTasks

classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
nkResources

nkResources

classLogManager4 members

Methods

  • getReceiver()
  • setReceiver(arg0)
  • log(arg0, arg1)

Static methods

  • staticgetInstance()
classResourceManager7 members

Methods

  • setWorkingPath(arg0)
  • setWorkingPathAbsolute(arg0)
  • getWorkingPath()
  • getWorkingPathAbsolute()
  • makeRequest(url)
  • loadFileIntoMemory(url)+ loadFileIntoMemory_u()

Static methods

  • staticgetInstance()
playground

playground

The page's own utilities, injected into your code by the playground (see playground-context.ts).

Hand-written — the generator pass for this surface is not in yet.

fngetCanvasContainer(options?: CanvasOptions): HTMLElement

Reveals the Canvas pane above the console and returns its host element to append a surface to (e.g. a rendering context's DOM canvas). Clears any surface the previous run left behind.

optionsCanvasOptionsoptional
`{ width?, height?, title? }` — width/height in px (defaults: 100% × 480), title sets the pane header.

returnsHTMLElement

fnattachCanvas(title: string, element: HTMLElement): void

Convenience wrapper: reveals the Canvas pane (titled `title`) and appends `element`, stretched to fill it. This is what demos use to surface engine canvas output.

titlestring
Shown in the Canvas pane header.
elementHTMLElement
The surface to attach (typically a canvas element from the engine).
fncloseCanvasContainer(): void

Tears down the canvas surface and hides the Canvas pane again.

fntoggleCollapse(): void

Folds or unfolds the visible Canvas pane (the surface stays mounted).

fnlog(...args: unknown[]): void

Writes a line to the Console pane (same sink as the global `log`).

...argsunknown[]
Anything — objects are JSON-formatted like the console rows show.
fnrequestFrame(callback: (now: number) => void): number

Books an animation frame; the id is tracked so a re-run cancels stray frames automatically.

callback(now: number) => void
Called once with the frame timestamp (rAF-based; timeout-emulated in Node).

returnsnumberframe id, for cancelFrame().

fncancelFrame(frameId: number): boolean

Cancels one pending frame. Returns whether a frame was actually cancelled.

frameIdnumber
Id from requestFrame().

returnsboolean

fncancelAllFrames(): number

Cancels every frame this session booked; returns how many were pending.

returnsnumber

Built-ins

Built-ins

Always in scope in every run, independent of the namespace list.

Hand-written — the generator pass for this surface is not in yet.

built-innk

The engine object itself — every namespace above is also reachable as `nk.<namespace>` (e.g. `nk.nkMaths.Vector`), or plain when the namespace is in scope.

built-inlog(...args: unknown[]): void

Writes a line to the Console pane. Identical to `playground.log`. Non-string values are formatted (objects via JSON).

...argsunknown[]
Values to append.
built-inconsole

The browser's `console` (info/warn/error/…), exposed as-is so engine-style and web-style logging both work.

Hints

The code runs in your own browser, against the exact WebAssembly build you can download here.

Managed objects are garbage-collected for you; functions with an _u suffix return unmanaged instances that you must free with .delete().