How To

Mirror Engine API
Mirror Engine API
Core functionality for Mirror Engine: APIs for graphics, audio, input, physics, asset management, scripting and much more. It also includes an application framework and entity-component-system, making it easy to manage the lifetime of the game.
Namespaces
Classes
Animation
Asset
Graphics
- Batch
- BatchGroup
- BatchManager
- BoxGeometry
- CapsuleGeometry
- ConeGeometry
- CylinderGeometry
- DomeGeometry
- FogParams
- Geometry
- Layer
- LayerComposition
- LightingParams
- Lightmapper
- Material
- Mesh
- MeshInstance
- Morph
- MorphInstance
- MorphTarget
- Picker
- PlaneGeometry
- PostEffect
- PostEffectQueue
- QuadRender
- Scene
- ShaderMaterial
- Skin
- SkinInstance
- Sky
- SphereGeometry
- Sprite
- SpriteAnimationClip
- StandardMaterial
- StandardMaterialOptions
- Texture
- TextureAtlas
- TorusGeometry
Math
Other
Script
Sound
User Interface
- ElementDragHelper
- ElementInput
- ElementInputEvent
- ElementMouseEvent
- ElementSelectEvent
- ElementTouchEvent
- Font
Variables
Animation
- ANIM_BLEND_1D
- ANIM_BLEND_2D_CARTESIAN
- ANIM_BLEND_2D_DIRECTIONAL
- ANIM_BLEND_DIRECT
- ANIM_EQUAL_TO
- ANIM_GREATER_THAN
- ANIM_GREATER_THAN_EQUAL_TO
- ANIM_INTERRUPTION_NEXT
- ANIM_INTERRUPTION_NEXT_PREV
- ANIM_INTERRUPTION_NONE
- ANIM_INTERRUPTION_PREV
- ANIM_INTERRUPTION_PREV_NEXT
- ANIM_LAYER_ADDITIVE
- ANIM_LAYER_OVERWRITE
- ANIM_LESS_THAN
- ANIM_LESS_THAN_EQUAL_TO
- ANIM_NOT_EQUAL_TO
- ANIM_PARAMETER_BOOLEAN
- ANIM_PARAMETER_FLOAT
- ANIM_PARAMETER_INTEGER
- ANIM_PARAMETER_TRIGGER
- ANIM_STATE_ANY
- ANIM_STATE_END
- ANIM_STATE_START
- INTERPOLATION_CUBIC
- INTERPOLATION_LINEAR
- INTERPOLATION_STEP
Asset
- ASSET_ANIMATION
- ASSET_AUDIO
- ASSET_CONTAINER
- ASSET_CSS
- ASSET_CUBEMAP
- ASSET_HTML
- ASSET_IMAGE
- ASSET_JSON
- ASSET_MATERIAL
- ASSET_SCRIPT
- ASSET_SHADER
- ASSET_TEXT
- ASSET_TEXTURE
- ASSET_TEXTUREATLAS
Debug
- TRACE_ID_ELEMENT
- TRACEID_BINDGROUP_ALLOC
- TRACEID_BINDGROUPFORMAT_ALLOC
- TRACEID_COMPUTEPIPELINE_ALLOC
- TRACEID_GPU_TIMINGS
- TRACEID_PIPELINELAYOUT_ALLOC
- TRACEID_RENDER_ACTION
- TRACEID_RENDER_FRAME
- TRACEID_RENDER_FRAME_TIME
- TRACEID_RENDER_PASS
- TRACEID_RENDER_PASS_DETAIL
- TRACEID_RENDER_QUEUE
- TRACEID_RENDER_TARGET_ALLOC
- TRACEID_RENDERPIPELINE_ALLOC
- TRACEID_SHADER_ALLOC
- TRACEID_SHADER_COMPILE
- TRACEID_TEXTURE_ALLOC
- TRACEID_TEXTURES
- TRACEID_VRAM_IB
- TRACEID_VRAM_SB
- TRACEID_VRAM_TEXTURE
- TRACEID_VRAM_VB
Graphics
- ASPECT_AUTO
- ASPECT_MANUAL
- BAKE_COLOR
- BAKE_COLORDIR
- BLEND_ADDITIVE
- BLEND_ADDITIVEALPHA
- BLEND_MAX
- BLEND_MIN
- BLEND_MULTIPLICATIVE
- BLEND_MULTIPLICATIVE2X
- BLEND_NONE
- BLEND_NORMAL
- BLEND_PREMULTIPLIED
- BLEND_SCREEN
- BLEND_SUBTRACTIVE
- BLUR_BOX
- BLUR_GAUSSIAN
- CUBEPROJ_BOX
- CUBEPROJ_NONE
- DETAILMODE_ADD
- DETAILMODE_MAX
- DETAILMODE_MIN
- DETAILMODE_MUL
- DETAILMODE_OVERLAY
- DETAILMODE_SCREEN
- DITHER_BAYER8
- DITHER_BLUENOISE
- DITHER_IGNNOISE
- DITHER_NONE
- EMITTERSHAPE_BOX
- EMITTERSHAPE_SPHERE
- FOG_EXP
- FOG_EXP2
- FOG_LINEAR
- FOG_NONE
- FRESNEL_NONE
- FRESNEL_SCHLICK
- GAMMA_NONE
- GAMMA_SRGB
- LAYERID_DEPTH
- LAYERID_IMMEDIATE
- LAYERID_SKYBOX
- LAYERID_UI
- LAYERID_WORLD
- LIGHTFALLOFF_INVERSESQUARED
- LIGHTFALLOFF_LINEAR
- LIGHTSHAPE_DISK
- LIGHTSHAPE_PUNCTUAL
- LIGHTSHAPE_RECT
- LIGHTSHAPE_SPHERE
- LIGHTTYPE_DIRECTIONAL
- LIGHTTYPE_OMNI
- LIGHTTYPE_SPOT
- ORIENTATION_HORIZONTAL
- ORIENTATION_VERTICAL
- PARTICLEORIENTATION_EMITTER
- PARTICLEORIENTATION_SCREEN
- PARTICLEORIENTATION_WORLD
- PARTICLESORT_DISTANCE
- PARTICLESORT_NEWER_FIRST
- PARTICLESORT_NONE
- PARTICLESORT_OLDER_FIRST
- PROJECTION_ORTHOGRAPHIC
- PROJECTION_PERSPECTIVE
- RENDERSTYLE_POINTS
- RENDERSTYLE_SOLID
- RENDERSTYLE_WIREFRAME
- SHADER_DEPTH
- SHADER_FORWARD
- SHADERPASS_ALBEDO
- SHADERPASS_AO
- SHADERPASS_EMISSION
- SHADERPASS_FORWARD
- SHADERPASS_GLOSS
- SHADERPASS_LIGHTING
- SHADERPASS_METALNESS
- SHADERPASS_OPACITY
- SHADERPASS_SPECULARITY
- SHADERPASS_UV0
- SHADERPASS_WORLDNORMAL
- SHADOW_PCF1_16F
- SHADOW_PCF1_32F
- SHADOW_PCF3_32F
- SHADOW_PCF5_16F
- SHADOW_PCF5_32F
- SHADOW_PCSS_32F
- SHADOW_VSM_16F
- SHADOW_VSM_32F
- SHADOWUPDATE_NONE
- SHADOWUPDATE_REALTIME
- SHADOWUPDATE_THISFRAME
- SKYTYPE_BOX
- SKYTYPE_DOME
- SKYTYPE_INFINITE
- SORTMODE_BACK2FRONT
- SORTMODE_FRONT2BACK
- SORTMODE_MANUAL
- SORTMODE_MATERIALMESH
- SORTMODE_NONE
- SPECOCC_AO
- SPECOCC_GLOSSDEPENDENT
- SPECOCC_NONE
- SPRITE_RENDERMODE_SIMPLE
- SPRITE_RENDERMODE_SLICED
- SPRITE_RENDERMODE_TILED
- SPRITETYPE_ANIMATED
- SPRITETYPE_SIMPLE
- TONEMAP_ACES
- TONEMAP_ACES2
- TONEMAP_FILMIC
- TONEMAP_HEJL
- TONEMAP_LINEAR
- TONEMAP_NEUTRAL
- TONEMAP_NONE
- VIEW_CENTER
- VIEW_LEFT
- VIEW_RIGHT
Other
- FILLMODE_FILL_WINDOW
- FILLMODE_KEEP_ASPECT
- FILLMODE_NONE
- RESOLUTION_AUTO
- RESOLUTION_FIXED
SHADOW_PCF3
Physics
User Interface
- BUTTON_TRANSITION_MODE_SPRITE_CHANGE
- BUTTON_TRANSITION_MODE_TINT
- ELEMENTTYPE_GROUP
- ELEMENTTYPE_IMAGE
- ELEMENTTYPE_TEXT
- FITMODE_CONTAIN
- FITMODE_COVER
- FITMODE_STRETCH
- FITTING_BOTH
- FITTING_NONE
- FITTING_SHRINK
- FITTING_STRETCH
- SCALEMODE_BLEND
- SCALEMODE_NONE
- SCROLL_MODE_BOUNCE
- SCROLL_MODE_CLAMP
- SCROLL_MODE_INFINITE
- SCROLLBAR_VISIBILITY_SHOW_ALWAYS
- SCROLLBAR_VISIBILITY_SHOW_WHEN_REQUIRED
Functions
Graphics
Components
Animation
Graphics
- CameraComponent
- GSplatComponent
- LightComponent
- ParticleSystemComponent
- RenderComponent
- SpriteComponent
Physics
Script
Sound
User Interface
- ButtonComponent
- ElementComponent
- LayoutChildComponent
- LayoutGroupComponent
- ScreenComponent
- ScrollbarComponent
- ScrollViewComponent