WorldRender (Nu)

WorldRender Module

Namespace: Nu
Assembly: Nu.dll

Rendering functions for the world.

Type extensions

Type extension	Description
`World.createUserDefinedStaticModel surfaceDescriptors bounds staticModel world` Full Usage: `World.createUserDefinedStaticModel surfaceDescriptors bounds staticModel world` Parameters: surfaceDescriptors : `StaticModelSurfaceDescriptor array` bounds : `Box3` staticModel : `StaticModel AssetTag` world : `World`	Send a message to the render to create the given user-defined static model. Extended Type: `World` surfaceDescriptors : `StaticModelSurfaceDescriptor array` bounds : `Box3` staticModel : `StaticModel AssetTag` world : `World`
`World.destroyUserDefinedStaticModel staticModel world` Full Usage: `World.destroyUserDefinedStaticModel staticModel world` Parameters: staticModel : `StaticModel AssetTag` world : `World`	Send a message to the render to destroy the given user-defined static model. Extended Type: `World` staticModel : `StaticModel AssetTag` world : `World`
`World.enqueueLayeredOperation2d operation world` Full Usage: `World.enqueueLayeredOperation2d operation world` Parameters: operation : `LayeredOperation2d` world : `World`	Enqueue a layered operation for 2d rendering. Extended Type: `World` operation : `LayeredOperation2d` world : `World`
`World.enqueueLayeredOperations2d operations world` Full Usage: `World.enqueueLayeredOperations2d operations world` Parameters: operations : `LayeredOperation2d seq` world : `World`	Enqueue multiple layered operation for 2d rendering, bypassing enqueueRenderMessage for speed. Extended Type: `World` operations : `LayeredOperation2d seq` world : `World`
`World.enqueueRenderMessage2d message world` Full Usage: `World.enqueueRenderMessage2d message world` Parameters: message : `RenderMessage2d` world : `World`	Enqueue a 2d rendering message. Extended Type: `World` message : `RenderMessage2d` world : `World`
`World.enqueueRenderMessage3d message world` Full Usage: `World.enqueueRenderMessage3d message world` Parameters: message : `RenderMessage3d` world : `World`	Enqueue a rendering message to the world. Extended Type: `World` message : `RenderMessage3d` world : `World`
`World.enqueueRenderMessageImGui message world` Full Usage: `World.enqueueRenderMessageImGui message world` Parameters: message : `RenderMessageImGui` world : `World`	Enqueue a rendering message to the world. Extended Type: `World` message : `RenderMessageImGui` world : `World`
`World.enqueueRenderMessages2d messages world` Full Usage: `World.enqueueRenderMessages2d messages world` Parameters: messages : `RenderMessage2d seq` world : `World`	Enqueue multiple 2d rendering messages. Extended Type: `World` messages : `RenderMessage2d seq` world : `World`
`World.enqueueRenderMessages3d messages world` Full Usage: `World.enqueueRenderMessages3d messages world` Parameters: messages : `RenderMessage3d seq` world : `World`	Enqueue multiple 3d rendering messages to the world. Extended Type: `World` messages : `RenderMessage3d seq` world : `World`
`World.getRenderer3dConfig world` Full Usage: `World.getRenderer3dConfig world` Parameters: world : `World` Returns: `Renderer3dConfig`	Get the current configuration of the 3d renderer. Extended Type: `World` world : `World` Returns: `Renderer3dConfig`
`World.loadRenderPackage2d packageName world` Full Usage: `World.loadRenderPackage2d packageName world` Parameters: packageName : `string` world : `World`	Load a 2d render asset package. Should be used to avoid loading assets at inconvenient times (such as in the middle of game play!) Extended Type: `World` packageName : `string` world : `World`
`World.loadRenderPackage3d packageName world` Full Usage: `World.loadRenderPackage3d packageName world` Parameters: packageName : `string` world : `World`	Load a 3d render asset package. Should be used to avoid loading assets at inconvenient times (such as in the middle of game play!) Extended Type: `World` packageName : `string` world : `World`
`World.mapRenderer3dConfig mapper world` Full Usage: `World.mapRenderer3dConfig mapper world` Parameters: mapper : `Renderer3dConfig -> Renderer3dConfig` world : `World`	Map the configuration of the 3d renderer. Extended Type: `World` mapper : `Renderer3dConfig -> Renderer3dConfig` world : `World`
`World.reloadRenderAssets2d world` Full Usage: `World.reloadRenderAssets2d world` Parameters: world : `World`	Send a message to the 2d renderer to reload its rendering assets. Extended Type: `World` world : `World`
`World.reloadRenderAssets3d world` Full Usage: `World.reloadRenderAssets3d world` Parameters: world : `World`	Send a message to the 3d renderer to reload its rendering assets. Extended Type: `World` world : `World`
`World.reloadRenderAssetsImGui world` Full Usage: `World.reloadRenderAssetsImGui world` Parameters: world : `World`	Send a message to the ImGui renderer to reload its rendering assets. Extended Type: `World` world : `World`
`World.renderAnimatedModelFast (modelMatrix, castShadow, presence, insetOpt, materialProperties, animations, animatedModel, subsortOffsets, drsIndices, depthTest, renderType, renderPass, world)` Full Usage: `World.renderAnimatedModelFast (modelMatrix, castShadow, presence, insetOpt, materialProperties, animations, animatedModel, subsortOffsets, drsIndices, depthTest, renderType, renderPass, world)` Parameters: modelMatrix : `inref<Matrix4x4>` castShadow : `bool` presence : `Presence` insetOpt : `Box2 voption` materialProperties : `inref<MaterialProperties>` animations : `Matrix4x4 array` animatedModel : `AnimatedModel AssetTag` subsortOffsets : `Map<int, single>` drsIndices : `Set<int>` depthTest : `DepthTest` renderType : `RenderType` renderPass : `RenderPass` world : `World`	Send a message to the render system to render an animated model using a fast path. Extended Type: `World` modelMatrix : `inref<Matrix4x4>` castShadow : `bool` presence : `Presence` insetOpt : `Box2 voption` materialProperties : `inref<MaterialProperties>` animations : `Matrix4x4 array` animatedModel : `AnimatedModel AssetTag` subsortOffsets : `Map<int, single>` drsIndices : `Set<int>` depthTest : `DepthTest` renderType : `RenderType` renderPass : `RenderPass` world : `World`
`World.renderGuiSprite absolute perimeter spriteImage offset elevation color world` Full Usage: `World.renderGuiSprite absolute perimeter spriteImage offset elevation color world` Parameters: absolute : `bool` perimeter : `Box3` spriteImage : `Image AssetTag` offset : `Vector3` elevation : `single` color : `Color` world : `World`	Render a gui sprite. Extended Type: `World` absolute : `bool` perimeter : `Box3` spriteImage : `Image AssetTag` offset : `Vector3` elevation : `single` color : `Color` world : `World`
`World.renderGuiSpriteSliced absolute perimeter margin spriteImage offset elevation color world` Full Usage: `World.renderGuiSpriteSliced absolute perimeter margin spriteImage offset elevation color world` Parameters: absolute : `bool` perimeter : `Box3` margin : `Vector2` spriteImage : `Image AssetTag` offset : `Vector3` elevation : `single` color : `Color` world : `World`	Render a gui sprite with 9-way slicing. Extended Type: `World` absolute : `bool` perimeter : `Box3` margin : `Vector2` spriteImage : `Image AssetTag` offset : `Vector3` elevation : `single` color : `Color` world : `World`
`World.renderGuiText absolute perimeter offset elevation shift clipOpt justification cursorOpt textMargin color font fontSizing fontStyling text world` Full Usage: `World.renderGuiText absolute perimeter offset elevation shift clipOpt justification cursorOpt textMargin color font fontSizing fontStyling text world` Parameters: absolute : `bool` perimeter : `Box3` offset : `Vector3` elevation : `single` shift : `single` clipOpt : `Box2 voption` justification : `Justification` cursorOpt : `int option` textMargin : `Vector3` color : `Color` font : `Font AssetTag` fontSizing : `int option` fontStyling : `Set<FontStyle>` text : `string` world : `World`	Extended Type: `World` absolute : `bool` perimeter : `Box3` offset : `Vector3` elevation : `single` shift : `single` clipOpt : `Box2 voption` justification : `Justification` cursorOpt : `int option` textMargin : `Vector3` color : `Color` font : `Font AssetTag` fontSizing : `int option` fontStyling : `Set<FontStyle>` text : `string` world : `World`
`World.renderLayeredSpriteFast (elevation, horizon, assetTag, transform, insetOpt, clipOpt, image, color, blend, emission, flip, world)` Full Usage: `World.renderLayeredSpriteFast (elevation, horizon, assetTag, transform, insetOpt, clipOpt, image, color, blend, emission, flip, world)` Parameters: elevation : `single` horizon : `single` assetTag : `AssetTag` transform : `inref<Transform>` insetOpt : `inref<ValueOption<Box2>>` clipOpt : `inref<ValueOption<Box2>>` image : `Image AssetTag` color : `inref<Color>` blend : `Blend` emission : `inref<Color>` flip : `Flip` world : `World`	Send a message to the render system to render a static model using a fast path. Extended Type: `World` elevation : `single` horizon : `single` assetTag : `AssetTag` transform : `inref<Transform>` insetOpt : `inref<ValueOption<Box2>>` clipOpt : `inref<ValueOption<Box2>>` image : `Image AssetTag` color : `inref<Color>` blend : `Blend` emission : `inref<Color>` flip : `Flip` world : `World`
`World.renderStaticModelFast (modelMatrix, castShadow, presence, insetOpt, materialProperties, staticModel, clipped, depthTest, renderType, renderPass, world)` Full Usage: `World.renderStaticModelFast (modelMatrix, castShadow, presence, insetOpt, materialProperties, staticModel, clipped, depthTest, renderType, renderPass, world)` Parameters: modelMatrix : `inref<Matrix4x4>` castShadow : `bool` presence : `Presence` insetOpt : `Box2 voption` materialProperties : `inref<MaterialProperties>` staticModel : `StaticModel AssetTag` clipped : `bool` depthTest : `DepthTest` renderType : `RenderType` renderPass : `RenderPass` world : `World`	Send a message to the render system to render a static model using a fast path. Extended Type: `World` modelMatrix : `inref<Matrix4x4>` castShadow : `bool` presence : `Presence` insetOpt : `Box2 voption` materialProperties : `inref<MaterialProperties>` staticModel : `StaticModel AssetTag` clipped : `bool` depthTest : `DepthTest` renderType : `RenderType` renderPass : `RenderPass` world : `World`
`World.renderStaticModelSurfaceFast (modelMatrix, castShadow, presence, insetOpt, materialProperties, material, staticModel, surfaceIndex, depthTest, renderType, renderPass, world)` Full Usage: `World.renderStaticModelSurfaceFast (modelMatrix, castShadow, presence, insetOpt, materialProperties, material, staticModel, surfaceIndex, depthTest, renderType, renderPass, world)` Parameters: modelMatrix : `inref<Matrix4x4>` castShadow : `bool` presence : `Presence` insetOpt : `Box2 voption` materialProperties : `inref<MaterialProperties>` material : `inref<Material>` staticModel : `StaticModel AssetTag` surfaceIndex : `int` depthTest : `DepthTest` renderType : `RenderType` renderPass : `RenderPass` world : `World`	Send a message to the render system to render a static model surface using a fast path. Extended Type: `World` modelMatrix : `inref<Matrix4x4>` castShadow : `bool` presence : `Presence` insetOpt : `Box2 voption` materialProperties : `inref<MaterialProperties>` material : `inref<Material>` staticModel : `StaticModel AssetTag` surfaceIndex : `int` depthTest : `DepthTest` renderType : `RenderType` renderPass : `RenderPass` world : `World`
`World.setRenderer3dConfig config world` Full Usage: `World.setRenderer3dConfig config world` Parameters: config : `Renderer3dConfig` world : `World`	Set the current configuration of the 3d renderer. Extended Type: `World` config : `Renderer3dConfig` world : `World`
`World.unloadRenderPackage2d packageName world` Full Usage: `World.unloadRenderPackage2d packageName world` Parameters: packageName : `string` world : `World`	Unload a 2d render package should be unloaded since its assets will not be used again soon. Extended Type: `World` packageName : `string` world : `World`
`World.unloadRenderPackage3d packageName world` Full Usage: `World.unloadRenderPackage3d packageName world` Parameters: packageName : `string` world : `World`	Unload a 3d render package should be unloaded since its assets will not be used again soon. Extended Type: `World` packageName : `string` world : `World`