Console Clear
Starting the WebAssembly engine…
What's in scope nkMaths127 members Vectors, quaternions, matrices nkMemory27 members Buffers and buffer views nkScripts136 members Lua scripts, environments, interpreters nkGraphics974 members Buffers, cameras, render contexts nkImages103 members Image data and encoding nkLog3 members Loggers and log receivers nkDebug93 members Testing framework and diagnostics nkWinUi84 members System and UI components nkExport3 members Utilities (e.g. Base64 encoding) nkAstraeus273 members Effects nkSounds62 members nkTasks5 members nkResources13 members playground8 members The page's own utilities, injected into your code by the playground (see playground-context.ts). Built-ins3 members Always in scope in every run, independent of the namespace list.
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.
enum MathConstants9 members Methods PI = 3.1415927410125732PI_SQRT = 1.7724539041519165PI_2 = 6.2831854820251465PI_4 = 12.566370964050293PI_OVER_2 = 1.5707963705062866PI_OVER_3 = 1.0471975803375244PI_OVER_4 = 0.7853981852531433PI_OVER_6 = 0.5235987901687622PI_OVER_8 = 0.39269909262657166class Rectangle6 members Properties · _xr/w · _yr/w · _widthr/w · _heightr/w class Hasher4 members Static methods static hashString(arg0)static hashNumber(arg0)static combineIntoHashString(arg0, arg1)static combineIntoHashNumber(arg0, arg1)class Matrixmanaged + unmanaged 50 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() class Quaternionmanaged + unmanaged 21 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() class Vectormanaged + unmanaged 58 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 static distanceVec2(a, b)static distanceVec3(a, b)static distanceVec4(a, b)static distanceSquaredVec2(a, b)static distanceSquaredVec3(a, b)static distanceSquaredVec4(a, b)static dotVec2(a, b)static dotVec3(a, b)static dotVec4(a, b)static crossVec3(a, b)+ crossVec3_u() class Pointmanaged + unmanaged 4 members nkMemory
class String2 members class StringView1 member class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)class Buffermanaged + unmanaged 15 members Constructors · Buffer()· Buffer(a)· Buffer(a, b)Methods · getData()· getSize()· empty()· front()· back()· clear()· resize(size)· append(value)· erase(index, count=1)· get(index)· assign(b)class BufferViewmanaged + unmanaged 11 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.
enum EXECUTION_FAILURE_TYPE7 members Methods NO_ERRORUNKNOWNINTERPRETER_UNKNOWNINTERPRETER_TYPE_MISMATCHBYTECODE_NOT_READYRUNTIMEMEMORY_ALLOCATIONenum FUNCTION_PARAMETER_TYPE10 members Methods VOIDBOOLINTFLOATDOUBLESTRINGUSER_DATAUSER_DATA_PTRSCRIPT_FUNCTIONSCRIPT_OBJECTenum TYPE_BUILT_IN_FUNCTIONS12 members Methods BUILT_IN_TO_STRINGBUILT_IN_UNARY_MINUSBUILT_IN_ADDBUILT_IN_SUBBUILT_IN_MULBUILT_IN_DIVBUILT_IN_MODBUILT_IN_POWBUILT_IN_CONCATBUILT_IN_EQBUILT_IN_LTBUILT_IN_LEenum INTERPRETER2 members enum COMPILATION_FAILURE_TYPE5 members Methods NO_ERRORUNKNOWNINTERPRETER_UNKNOWNSYNTAXMEMORY_ALLOCATIONclass Environment27 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)class EnvironmentManager7 members Methods · createOrRetrieve(arg0)· get(arg0)· getByIndex(arg0)· rename(arg0, arg1)· erase(arg0)Static methods static getInstance()static kill()class Function4 members Methods · getName()· addParameter(...args)· setFunction(arg0)· reset()class DataStack3 members class Namespace12 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()class ScriptObjectReference4 members Constructors · ScriptObjectReference()· ScriptObjectReference(a)class ScriptObjectView1 member class UserType7 members Methods · getName()· getFullName()· getMethod(arg0)· getStaticMethod(arg0)· addMethod(...args)· addStaticMethod(arg0)· overrideBuiltInFunction(arg0)class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)class Script10 members Methods · getTargetInterpreter()· getName()· getSources()· getLastCompilationResult()+ getLastCompilationResult_u() · setTargetInterpreter(arg0)· setName(arg0)· setSources(arg0)· load()· unload()class ScriptManager7 members Methods · createOrRetrieve(arg0)· get(arg0)· getByIndex(arg0)· rename(arg0, arg1)· erase(arg0)Static methods static getInstance()static kill()class ExecutionResultmanaged + unmanaged 4 members Constructors · ExecutionResult(a, b, c)Properties · _failureMessager/w = "" · _failureTyper/w = nkScripts.EXECUTION_FAILURE_TYPE.NO_ERROR · _successr/w = true class FunctionParametermanaged + unmanaged 10 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 class CompilationResultmanaged + unmanaged 4 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.
enum BUFFER_BIND_FLAG11 members Methods BIND_NONEBIND_VERTEX_BUFFERBIND_INDEX_BUFFERBIND_CONSTANT_BUFFERBIND_SHADER_RESOURCEBIND_STREAM_OUTPUTBIND_RENDER_TARGETBIND_DEPTH_STENCILBIND_UNORDERED_ACCESSBIND_DECODERBIND_VIDEO_ENCODERenum BUFFER_CPU_ACCESS_FLAG4 members Methods CPU_ACCESS_NONECPU_ACCESS_WRITECPU_ACCESS_READCPU_ACCESS_READ_WRITEenum BUFFER_USAGE4 members Methods USAGE_DEFAULTUSAGE_IMMUTABLEUSAGE_DYNAMICUSAGE_STAGINGenum OBJ_SPACE2 members Methods UP_Y_FRONT_ZUP_Y_FRONT_MINUS_Zenum ATTRIBUTE_GRANULARITY2 members enum INDEX_FORMAT2 members enum PRIMITIVE_TOPOLOGY10 members Methods PRIMITIVE_TOPOLOGY_UNDEFINEDPOINTLISTLINELISTLINESTRIPTRIANGLELISTTRIANGLESTRIPLINELIST_ADJLINESTRIP_ADJTRIANGLELIST_ADJTRIANGLESTRIP_ADJenum DATA_FILL_TYPE3 members enum PASS_TYPE8 members Methods UNKNOWNCLEAR_TARGETSCOMPUTEINSTANCINGMONO_MATERIALPOST_PROCESSRENDER_SCENERAYTRACINGenum PROGRAM_TYPE5 members Methods UNKNOWNCOMPUTEGEOMETRYPIPELINERAYTRACINGenum BLEND17 members Methods BLEND_ZEROBLEND_ONEBLEND_SRC_COLORBLEND_INV_SRC_COLORBLEND_SRC_ALPHABLEND_INV_SRC_ALPHABLEND_DEST_ALPHABLEND_INV_DEST_ALPHABLEND_DEST_COLORBLEND_INV_DEST_COLORBLEND_SRC_ALPHA_SATBLEND_BLEND_FACTORBLEND_INV_BLEND_FACTORBLEND_SRC1_COLORBLEND_INV_SRC1_COLORBLEND_SRC1_ALPHABLEND_INV_SRC1_ALPHAenum BLEND_OP5 members Methods BLEND_OP_ADDBLEND_OP_SUBTRACTBLEND_OP_REV_SUBTRACTBLEND_OP_MINBLEND_OP_MAXenum COLOR_WRITE_ENABLE5 members Methods COLOR_WRITE_ENABLE_REDCOLOR_WRITE_ENABLE_GREENCOLOR_WRITE_ENABLE_BLUECOLOR_WRITE_ENABLE_ALPHACOLOR_WRITE_ENABLE_ALLenum FILL_MODE2 members enum CULL_MODE3 members Methods CULL_NONECULL_FRONTCULL_BACKenum RENDERING_API2 members enum RESOURCE_LOAD_STATE4 members Methods UNLOADEDLOADINGREADY_FOR_RENDERINGLOADEDenum RESOURCE_MISC_FLAG18 members Methods RESOURCE_MISC_NONERESOURCE_MISC_GENERATE_MIPSRESOURCE_MISC_SHAREDRESOURCE_MISC_TEXTURECUBERESOURCE_MISC_DRAWINDIRECT_ARGSRESOURCE_MISC_BUFFER_ALLOW_RAW_VIEWSRESOURCE_MISC_BUFFER_STRUCTUREDRESOURCE_MISC_RESOURCE_CLAMPRESOURCE_MISC_SHARED_KEYEDMUTEXRESOURCE_MISC_GDI_COMPATIBLERESOURCE_MISC_SHARED_NTHANDLERESOURCE_MISC_RESTRICTED_CONTENTRESOURCE_MISC_RESTRICT_SHARED_RESOURCERESOURCE_MISC_RESTRICT_SHARED_RESOURCE_DRIVERRESOURCE_MISC_GUARDEDRESOURCE_MISC_TILE_POOLRESOURCE_MISC_TILEDRESOURCE_MISC_HW_PROTECTEDenum RESOURCE_TYPE13 members Methods UNKNOWNCOMPOSITORMESHBLEND_STATEDEPTH_STENCIL_STATERASTER_STATEPROGRAMSHADERBUFFERACCELERATION_STRUCTURETEXTURESAMPLERNODE_WRAPPERenum COMPARISON_FUNCTION8 members Methods FUNCTION_NEVERFUNCTION_LESSFUNCTION_EQUALFUNCTION_LESS_EQUALFUNCTION_GREATERFUNCTION_NOT_EQUALFUNCTION_GREATER_EQUALFUNCTION_ALWAYSenum FILTER36 members Methods MIN_MAG_MIP_POINTMIN_MAG_POINT_MIP_LINEARMIN_POINT_MAG_LINEAR_MIP_POINTMIN_POINT_MAG_MIP_LINEARMIN_LINEAR_MAG_MIP_POINTMIN_LINEAR_MAG_POINT_MIP_LINEARMIN_MAG_LINEAR_MIP_POINTMIN_MAG_MIP_LINEARANISOTROPICCOMPARISON_MIN_MAG_MIP_POINTCOMPARISON_MIN_MAG_POINT_MIP_LINEARCOMPARISON_MIN_POINT_MAG_LINEAR_MIP_POINTCOMPARISON_MIN_POINT_MAG_MIP_LINEARCOMPARISON_MIN_LINEAR_MAG_MIP_POINTCOMPARISON_MIN_LINEAR_MAG_POINT_MIP_LINEARCOMPARISON_MIN_MAG_LINEAR_MIP_POINTCOMPARISON_MIN_MAG_MIP_LINEARCOMPARISON_ANISOTROPICMINIMUM_MIN_MAG_MIP_POINTMINIMUM_MIN_MAG_POINT_MIP_LINEARMINIMUM_MIN_POINT_MAG_LINEAR_MIP_POINTMINIMUM_MIN_POINT_MAG_MIP_LINEARMINIMUM_MIN_LINEAR_MAG_MIP_POINTMINIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEARMINIMUM_MIN_MAG_LINEAR_MIP_POINTMINIMUM_MIN_MAG_MIP_LINEARMINIMUM_ANISOTROPICMAXIMUM_MIN_MAG_MIP_POINTMAXIMUM_MIN_MAG_POINT_MIP_LINEARMAXIMUM_MIN_POINT_MAG_LINEAR_MIP_POINTMAXIMUM_MIN_POINT_MAG_MIP_LINEARMAXIMUM_MIN_LINEAR_MAG_MIP_POINTMAXIMUM_MIN_LINEAR_MAG_POINT_MIP_LINEARMAXIMUM_MIN_MAG_LINEAR_MIP_POINTMAXIMUM_MIN_MAG_MIP_LINEARMAXIMUM_ANISOTROPICenum TEXTURE_ADDRESS_MODE5 members Methods PER_VERTEXMODE_MIRRORMODE_CLAMPMODE_BORDERMODE_MIRROR_ONCEenum ShaderInstanceMemorySlot1 member enum ShaderPassMemorySlot1 member enum TEXTURE_TYPE3 members Methods TEXTURE_2DTEXTURE_3DTEXTURE_CUBEMAPenum TEXTURE_RENDER_FLAG3 members Methods NO_RENDERRENDER_TARGETDEPTH_RENDER_TARGETenum FORMAT90 members Methods UNKNOWN_FORMATR32G32B32A32_TYPELESSR32G32B32A32_FLOATR32G32B32A32_UINTR32G32B32A32_SINTR32G32B32_TYPELESSR32G32B32_FLOATR32G32B32_UINTR32G32B32_SINTR16G16B16A16_TYPELESSR16G16B16A16_FLOATR16G16B16A16_UNORMR16G16B16A16_UINTR16G16B16A16_SNORMR16G16B16A16_SINTR32G32_TYPELESSR32G32_FLOATR32G32_UINTR32G32_SINTR32G8X24_TYPELESSD32_FLOAT_S8X24_UINTR32_FLOAT_X8X24_TYPELESSX32_TYPELESS_G8X24_UINTR10G10B10A2_TYPELESSR10G10B10A2_UNORMR10G10B10A2_UINTR11G11B10_FLOATR8G8B8A8_TYPELESSR8G8B8A8_UNORMR8G8B8A8_UNORM_SRGBR8G8B8A8_UINTR8G8B8A8_SNORMR8G8B8A8_SINTR16G16_TYPELESSR16G16_FLOATR16G16_UNORMR16G16_UINTR16G16_SNORMR16G16_SINTR32_TYPELESSD32_FLOATR32_FLOATR32_UINTR32_SINTR24G8_TYPELESSD24_UNORM_S8_UINTR24_UNORM_X8_TYPELESSX24_TYPELESS_G8_UINTR8G8_TYPELESSR8G8_UNORMR8G8_UINTR8G8_SNORMR8G8_SINTR16_TYPELESSR16_FLOATD16_UNORMR16_UNORMR16_UINTR16_SNORMR16_SINTR8_TYPELESSR8_UNORMR8_UINTR8_SNORMR8_SINTA8_UNORMR1_UNORMR9G9B9E5_SHAREDEXPR8G8_B8G8_UNORMG8R8_G8B8_UNORMBC1_TYPELESSBC1_UNORMBC1_UNORM_SRGBBC2_TYPELESSBC2_UNORMBC2_UNORM_SRGBBC3_TYPELESSBC3_UNORMBC3_UNORM_SRGBBC4_TYPELESSBC4_UNORMBC4_SNORMBC5_TYPELESSBC5_UNORMBC5_SNORMB5G6R5_UNORMB5G5R5A1_UNORMB8G8R8A8_UNORMB8G8R8X8_UNORMFORCE_UINTenum SHADER_TYPE2 members Methods VERTEX_SHADERPIXEL_SHADERenum internal2 members class Buffer24 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)class BufferManager6 members Methods · createOrRetrieve(arg0)· get(arg0)· getByIndex(arg0)· rename(arg0, arg1)· erase(arg0)class Camera43 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() class CameraManager18 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()class Compositor12 members Methods · addNode()· deleteNode(arg0)· changeNodeOrder(arg0, arg1)· clearNodes()· getNodeCount()· getNode(arg0)· getName()· getHidden()· setName(arg0)· setHidden(arg0)· renderChain()class CompositorManager10 members Methods · getActiveCompositor()· getDefaultCompositor()· createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)· setActiveCompositor(arg0)· setDefaultCompositor(arg0)· prepareForContext(arg0)class CompositorNode12 members Methods · addOperations()· getOperations(arg0)· getOperationsCount()· deleteOperations(arg0)· changeOperationsOrder(arg0, arg1)· getName()· getParentCompositor()· getActive()· setName(arg0)· setParentCompositor()· setActive(arg0)· renderOperations()class TargetOperations24 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()class DecodedData1 member class DecodedMeshData0 members No methods, properties or constructors are exposed through this binding.
class ObjEncoder2 members Static methods static canDecode(buffer)static decode(buffer, options)class CompositeEncoder0 members No methods, properties or constructors are exposed through this binding.
class Entity6 members Methods · getParentNode()· getRenderQueue()· getUserData()· setRenderInfo(arg0)· setParentNode(arg0)· setUserData(arg0)class Node30 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)class NodeManager5 members Methods · createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)class Mesh29 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)class MeshManager5 members Methods · createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)class MeshUtils1 member Static methods static fillMeshFromDecodedData(...args)class ClearTargetsPass7 members Methods · setClearColor(arg0)· setColorTargetIndex(arg0)· setClearDepthValue(arg0)· setClearStencilValue(arg0)· setShouldClearColor(arg0)· setShouldClearDepth(arg0)· setShouldClearStencil(arg0)class InstancingPass9 members Methods · setToRender(arg0)· setInstanceNumber(arg0)· setShader(arg0)· setRenderCamera(arg0)· setCullingCamera(arg0)· setLodCamera(arg0)· setBlendState(arg0)· setRasterState(arg0)· setDepthStencilState()class MonoMaterialPass1 member class Pass2 members class PostProcessPass4 members Methods · setShader(arg0)· setBackProcess(arg0)· setBlendState(arg0)· setCamera(arg0)class RenderScenePass8 members Methods · setRenderQueue(arg0)· setRenderCamera(arg0)· setCullingCamera(arg0)· setLodCamera(arg0)· setBlendState(arg0)· setRasterState(arg0)· setDepthStencilState()· setTransparentPass(arg0)class Program9 members Methods · getLastCompilationResult()· isFromFile()· isFromMemory()· getMemory()· getId()· getType()· setFromMemory(arg0)· setActivateCrossCompilerDefines(arg0)class ProgramCompilationResult3 members Methods · getSuccess()· getErrorMessage()· getStage()class ProgramManager5 members Methods · createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)class RenderContext11 members Methods · getBackBuffer()· getDepthBuffer()· getViewport()· getCompositor()· getWidth()· getHeight()· isWindowFocused()· getAttachedWin()· getOwnsSurface()· setCompositor(arg0)· setGammaCorrected(arg0)class RenderContextManager9 members Methods · getRenderContextOf(arg0)· getActiveRenderContext()· getDefaultRenderContext()· createRenderContext(arg0)· eraseFor(arg0)· erase(arg0)· activateContextOf(arg0)· activateContext(arg0)class RenderQueue8 members Methods · getName()· getEntity(arg0)· getEntityCount()· getRenderStrategy()· addEntity()· eraseEntity(arg0)· clearQueue()class RenderQueueManager3 members Static methods static getInstance()static getDefaultRenderQueueName()class DefaultRenderStrategy8 members Methods · getLodQualityFactor()· getFrustumCull()· getOrderQueue()· getUseLodSystem()· setLodQualityFactor(arg0)· setFrustumCull(arg0)· setOrderQueue(arg0)· setUseLodSystem(arg0)class RenderStrategy1 member Methods · asDefaultRenderStrategy()class BlendState22 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()class BlendStateManager5 members Methods · createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)class RasterState26 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()class RasterStateManager5 members Methods · createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)class Resource12 members Methods · load(...args)· unload()· isReadyForRendering()· isUnloaded()· getLoadState()· getPath()· getTypeName()· getName()· getHidden()· setPath(arg0)· setName(arg0)· setHidden(arg0)class ShaderResource0 members No methods, properties or constructors are exposed through this binding.
class Sampler28 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()class SamplerManager2 members class ConstantBuffer5 members Methods · getPassMemorySlot(arg0)· getPassMemorySlotReadOnly(arg0)· addPassMemorySlot()· changePassMemorySlotOrder(arg0, arg1)· deletePassMemorySlot(arg0)class ShaderInstanceCustomSlot7 members Methods · getTypeName()· getSemanticName()· setSemanticName(arg0)· getDataByteSize()· fillDataBuffer()Static methods static implement(arg0)static extend(arg0, arg1)class ShaderMemorySlot2 members Methods · getSlotType()· getDataTypeAsString()class Shader35 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)class ShaderManager5 members Methods · createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)class System12 members Methods · getIsInitialized()· getHasRunToContinue()· setHasRunToContinue(arg0)· initialize(...args)· kill()· shutdown()· frame(...args)· tickForNewFrame(arg0)Static methods static getInstance()static getInstanceIfExisting()static kill()class Texture30 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)class TextureManager9 members Methods · createOrRetrieve(arg0)· get(arg0)· rename(arg0, arg1)· erase(arg0)· setActiveRenderTarget(arg0)· setActiveDepthTarget(arg0)· getActiveRenderTarget()· getDepthTarget()class TextureUtils13 members Static methods static getFormatByteSize(arg0)static getFormatChannelCount(arg0)static getFormatSrgbEquivalent(arg0)static getFormatRgbEquivalent(arg0)static getFormatTypelessEquivalent(arg0)static getFormatDepthEquivalent(arg0)static getFormatUncompressedEquivalent(arg0)static getFormatWithAlphaEquivalent(arg0)static isFormatOver255(arg0)static isFormatCompressed(arg0)static isFormatCompatibleForRenderFlag(arg0, arg1, arg2)static getNeededMipsForSize(arg0, arg1, arg2, arg3)static getFormatFromImageFormat(arg0)class Viewport16 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)class ViewportManager8 members Methods · getActiveViewport()· setActiveViewport(arg0)· createOrRetrieve(arg0)· get(arg0)· getByIndex(arg0)· rename(arg0, arg1)· erase(arg0)class BoundingBoxmanaged + unmanaged 13 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)class Frustummanaged + unmanaged 6 members Properties · _planesreadonly = [new nkMaths.Vector,new nkMaths.Vector,new nkMaths.Vector… Methods · getPlane(index)· setPlane(plane, index)· buildFrustum(viewMat, projMat)class TargetDescriptormanaged + unmanaged 7 members Constructors · TargetDescriptor()· TargetDescriptor(a)· TargetDescriptor(a, b)· TargetDescriptor(a, b, c)Properties · _targetreadonly = null · _indexInTextureArrayreadonly = 0 · _mipIndexreadonly = 0 class Configurationmanaged + unmanaged 2 members Properties · _wantedApireadonly = nkGraphics.RENDERING_API.AUTOMATIC}_toUnmanaged(targetNkI… class ObjDecodeOptions4 members Properties · _objSpacereadonly = nkGraphics.OBJ_SPACE.UP_Y_FRONT_Z · _invertUvYreadonly = false · _invertWindingOrderreadonly = false}} class EntityRenderInfomanaged + unmanaged 8 members Constructors · EntityRenderInfo()· EntityRenderInfo(a, b)Properties · _slotsreadonly = [] · _parentEntityreadonly = null Methods · getSlot(index)· getParentEntity()· addSlot(slot)· eraseSlot(index)class EntityRenderInfoSlotmanaged + unmanaged 8 members Constructors · EntityRenderInfoSlot()· EntityRenderInfoSlot(a, b)Properties · _lodsreadonly = [] · _parentEntityreadonly = null Methods · getLod(index)· getParentEntity()· addLod(lod)· eraseLod(index)class EntityRenderLodSlotmanaged + unmanaged 17 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)class MeshInputLayoutmanaged + unmanaged 18 members 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)class MeshInputLayoutAttributemanaged + unmanaged 9 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 class MeshFillOptionsmanaged + unmanaged 3 members Properties · _dataFillTyper/w = nkGraphics.DATA_FILL_TYPE.FORWARD · _autoLoadr/w = true}_toUnmanaged(targetNkId){const result=new nkGraphics… class ProgramSourcesHoldermanaged + unmanaged 11 members Properties · _vertexMemoryreadonly = "" · _pixelMemoryreadonly = "" · _macrosVertexreadonly = [] · _macrosPixelreadonly = []}getVertexMemory(){return this._vertexMemory}getPixelMe… Methods · getVertexMemory()· getPixelMemory()· setVertexMemory(sources)· setPixelMemory(sources)· addDefineMacroVertex(key, value)· addDefineMacroPixel(key, value)class RenderContextDescriptormanaged + unmanaged 7 members Constructors · RenderContextDescriptor()· RenderContextDescriptor(a, b, c)Properties · _widthreadonly = 1 · _heightreadonly = 1 · _windowreadonly = null · _texturereadonly = null · _offscreenContextreadonly = false nkImages
enum ALPHA_MODE3 members enum PIXEL_FORMAT19 members Methods UNKNOWN_FORMATR8R8A8R8G8B8R8G8B8A8B8G8R8B8G8R8A8R16G16B16A16R32G32B32R32G32B32A32Y8U8V8_444Y8U8Y8V8_422Y8U8V8_420_SPY8Y8U8Y8Y8V8_411BC1BC2BC3BC4BC5class BmpEncoder4 members Static methods static encode(arg0)static encodeBase(arg0)static canDecode(arg0)static decode(...args)class DdsEncoder3 members Static methods static encode(arg0)static canDecode(arg0)static decode(...args)class PixelFormatUtils4 members Static methods static getFormatByteSize(arg0)static isFormatCompressed(arg0)static isFormatFloatingPoint(arg0)static hasAlpha(arg0)class HdrEncoder3 members Static methods static encode(arg0)static canDecode(arg0)static decode(...args)class JpgEncoder3 members Static methods static encode()static canDecode(arg0)static decode(...args)class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)class CompositeEncoder2 members Static methods static canDecode(arg0)static decode(...args)class AlignmentDescriptor6 members Properties · _rowByteAlignmentreadonly = 1 · _pixelByteAlignmentreadonly = 1 · _alphaModereadonly = nkImages.ALPHA_MODE.AUTO · _forceRgbFormatreadonly = true · _forceRgbReorderingreadonly = false}} class Imagemanaged + unmanaged 23 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()class ImageBasemanaged + unmanaged 24 members 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() class ImageDescriptormanaged + unmanaged 8 members Constructors · ImageDescriptor()· ImageDescriptor(a)· ImageDescriptor(a, b)Properties · _mipsr/w = [] · _mipOffsetsr/w = [] Methods · getMip(index)· getMipOffset(index)· addMip(mip, mipOffset)class MipDescriptormanaged + unmanaged 15 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.
class ConsoleLogger2 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.
class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)class TestRunResult4 members Constructors · TestRunResult()· TestRunResult(a)Methods · getRejectionReason()· getSuccess()class ConsoleOutputFormatter3 members Constructors · ConsoleOutputFormatter()Static methods static implement(arg0)static extend(arg0, arg1)class NunitOutputFormatter3 members Static methods static implement(arg0)static extend(arg0, arg1)class DefaultTestObserver3 members Static methods static implement(arg0)static extend(arg0, arg1)class TestClassObserverInformation7 members Constructors · TestClassObserverInformation()Methods · getName()· getClassTotalFunctionCount()· getClassFilteredFunctionCount()· setName(arg0)· setClassTotalFunctionCount(arg0)· setClassFilteredFunctionCount(arg0)class TestFunctionObserverInformation7 members Constructors · TestFunctionObserverInformation()Methods · getName()· getTimeMicroS()· getRunResult()· setName(arg0)· setTimeMicroS(arg0)· setRunResult(arg0)class TestRunParameters7 members Methods · getClassNameFilter()· getFunctionNameFilter()· getObserver()· setClassNameFilter(arg0)· setFunctionNameFilter(arg0)· setObserver(arg0)class FunctionSet6 members Properties · _functionsreadonly = []}getTestFunction(index){if(index<this._functions.length… Methods · getTestFunction(index)· getTestFunctions(filter)· getSetSize()· registerFunction(name, func)class TestClass6 members Methods · getFunctionSet()· setClassInitFunction(f)· setClassShutdownFunction(f)· setTestFunctionInitFunction(f)· setTestFunctionShutdownFunction(f)· execute(parameters)class TestFunction7 members Properties · _namereadonly = name · _functionreadonly = func · _isAsyncreadonly = func.constructor.name=="AsyncFunction"}getName(){return t… Methods · getName()· getFunction()· getIsAsync()class TestUtils7 members Static methods static check(c, m="")static areNumbersEqual(a, b, p=0, m="")static areStringsEqual(a, b, m="")static areNumbersNotEqual(a, b, p=0, m="")static areStringsNotEqual(a, b, m="")static isNull(a, m="")static isNotNull(a, m="")const UnitTesterRun = falseclass UnitTester1 member class TestRunException5 members Properties · _rejectionReasonreadonly = "" · _rejectionStackreadonly = [] Methods · getRejectionReason()· getRejectionStack()class TestStackLevel7 members Properties · _functionNamereadonly = typeof functionName==="string"?functionName:"" · _linereadonly = typeof line==="number"?line:0}getFunctionName(){return th… Methods · getFunctionName()· getLine()· setFunctionName(value)· setLine(value)class OutputFormatter9 members Methods · formatRunLaunch(params)· formatRunEnd()· formatClassLaunch(info)· formatClassBypass(info)· formatClassEnd(info)· formatTestLaunch(info)· formatTestBypass(info)· formatTestSuccess(info)· formatTestFailure(info)class TestObserver9 members Methods · onRunLaunch(params)· onRunEnd()· onClassLaunch(info)· onClassBypass(info)· onClassEnd(info)· onTestLaunch(info)· onTestBypass(info)· onTestSuccess(info)· onTestFailure(info)nkWinUi
enum COMPONENT_TYPE2 members class Component49 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()class ComponentManager6 members Methods · createOrRetrieve(arg0, arg1)· get(arg0)· getByIndex(arg0)· rename(arg0, arg1)· erase(arg0)class Static4 members Methods · getDomElement()· getWordWrap()· setWordWrap(arg0)class Window3 members Methods · getCanvasName()· getDomElement()· setFromExternalCanvas(canvas)class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)class System8 members Methods · getComponentManager()· initialize()· tick()· prepareForShutdown()· shutdown()Static methods static getInstance()static kill()enum jsDom1 member nkExport
nkExport Utilities (e.g. Base64 encoding)
Automatically generated at build time from the shipped engine giving the complete in-scope API.
class Base64Encoder2 members Static methods static encode(...args)static decode(...args)nkAstraeus
nkSounds
enum AUDIO_ERROR7 members Methods NONEFORMAT_NOT_SUPPORTEDDEVICE_UNAVAILABLEBUFFER_UNDERRUNDECODER_ERROROUT_OF_MEMORYUNKNOWNenum AUDIO_FORMAT4 members Methods UNKNOWNPCM_FLOAT32PCM_INT16PCM_INT24enum CHANNEL_LAYOUT5 members Methods UNKNOWNMONOSTEREOSURROUND_5_1SURROUND_7_1enum SOUND_LOAD_MODE3 members Methods DECODEDCOMPRESSEDSTREAMEDclass Sound9 members Methods · setSource(arg0)· setLoadMode(arg0)· load()· getLoadMode()· getSourceFormat()· getChannelCount()· getSampleRate()· getTotalFrames()class AudioEffect2 members Methods · isActive()· setActive(arg0)class Bus9 members Methods · getChannelLayout()· getSampleRate()· getBlockSize()· addSource(arg0, arg1)· removeSource(arg0)· setSourceGain(arg0, arg1)· addEffect(arg0)· removeEffect(arg0)class AudioSource0 members No methods, properties or constructors are exposed through this binding.
class SoundInstance10 members Methods · getLoop()· setLoop(arg0)· getPitch()· setPitch(arg0)· getPan()· setPan(arg0)· fadeTo(arg0, arg1)· isFading()· isFinished()class System7 members Methods · initialize()· tick()· shutdown()· getMixer()Static methods static getInstance()static kill()nkTasks
class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)nkResources
class LogManager4 members Methods · getReceiver()· setReceiver(arg0)· log(arg0, arg1)class ResourceManager7 members Methods · setWorkingPath(arg0)· setWorkingPathAbsolute(arg0)· getWorkingPath()· getWorkingPathAbsolute()· makeRequest(url)· loadFileIntoMemory(url)+ loadFileIntoMemory_u() 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.
fn getCanvasContainer(options?: CanvasOptions): HTMLElementReveals 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.
optionsCanvasOptions optional `{ width?, height?, title? }` — width/height in px (defaults: 100% × 480), title sets the pane header. returns HTMLElement
fn attachCanvas(title: string, element: HTMLElement): voidConvenience 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). fn closeCanvasContainer(): voidTears down the canvas surface and hides the Canvas pane again.
Folds or unfolds the visible Canvas pane (the surface stays mounted).
fn log(...args: unknown[]): voidWrites a line to the Console pane (same sink as the global `log`).
...argsunknown[] Anything — objects are JSON-formatted like the console rows show. fn requestFrame(callback: (now: number) => void): numberBooks 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). returns numberframe id, for cancelFrame().
fn cancelFrame(frameId: number): booleanCancels one pending frame. Returns whether a frame was actually cancelled.
frameIdnumber Id from requestFrame(). returns boolean
fn cancelAllFrames(): numberCancels every frame this session booked; returns how many were pending.
returns number
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.
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-in log(...args: unknown[]): voidWrites a line to the Console pane. Identical to `playground.log`. Non-string values are formatted (objects via JSON).
...argsunknown[] Values to append. 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 .
Two families of classes sit side by side in the scope: managed ones, plain JavaScript classes that mirror the engine's unmanaged classes, and the unmanaged ones themselves, which live on the WebAssembly heap. They can be used transparently as every method accepts either kind, so the difference only ever matters for lifetime and for performance.
Managed instances live in the JavaScript memory space; they are garbage-collected like any other JS object, and you never call .delete() on them.This makes them comfortable to use but this has a cost: each time a managed instance is passed around (as a parameter, for instance) it has to be converted to its unmanaged counterpart behind the curtain. Note that the lifetime of that conversion is managed for you. Unmanaged instances live directly on the WebAssembly heap, so they must be freed with .delete() as soon as you no longer need them. That is how Emscripten manages that heap. Cumbersome, but manipulating this version is significantly faster than manipulating a managed one.The _u suffix makes that trade-off opt-in upon method call: functions return managed instances by default, keeping the safe memory scheme; the_u variant of the same function hands you the unmanaged instance instead, for when you want to pay for the speed. Managed classes follow the default naming pattern, for instance, nkMaths.Vector.nkMaths.unmanaged.Vector.