filament/io.github.erkko68.filament/RenderableManager

RenderableManager

class RenderableManager(nativeHandle: NativePointer)

Factory and manager for Renderables, which are entities that can be drawn.

Renderables are bundles of primitives, each with its own geometry and material. All primitives in a renderable share rendering attributes such as shadow casting, skinning, morphing, layer masks, and priority.

Creating renderables:

val entity = entityManager.create()
RenderableManager.Builder(1)          // 1 primitive
    .boundingBox(Box(floatArrayOf(0f, 0f, 0f), floatArrayOf(1f, 1f, 1f)))
    .material(0, materialInstance)
    .geometry(0, PrimitiveType.TRIANGLES, vertexBuffer, indexBuffer, 0, 6)
    .receiveShadows(true)
    .castShadows(true)
    .build(engine, entity)

scene.addEntity(entity)

Modifying renderables: To modify an existing renderable, use RenderableManager to get a temporary handle called an Instance. The instance is used to get/set rendering state. Instances are ephemeral; store Entity IDs, not instances.

Related components:

Use TransformManager to associate a 4x4 transform with an entity
Use LightManager to add lights
Use RenderableManager to add geometry and materials

Constructors

RenderableManager

constructor(nativeHandle: NativePointer)

Types

Bone

class Bone

A bone transform as a unit quaternion and a translation, the compact alternative to a 4x4 matrix.

Builder

class Builder(count: Int)

Adds renderable components to entities using a builder pattern.

Companion

object Companion

PrimitiveType

enum PrimitiveType : Enum<RenderableManager.PrimitiveType>

Primitive topology types.

Properties

componentCount

val componentCount: Int

The number of renderable components.

entities

val entities: IntArray

All entities with a renderable component, in no particular order.

nativeObject

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

Functions

clearMaterialInstanceAt

fun clearMaterialInstanceAt(instance: EntityInstance, primitiveIndex: Int)

Clears the material instance for a primitive (revert to default).

destroy

fun destroy(e: Entity)

Destroys the renderable component in the given entity.

empty

fun empty(): Boolean

Returns true if there are no renderable components.

getAxisAlignedBoundingBox

fun getAxisAlignedBoundingBox(instance: EntityInstance): Box

Gets the bounding box used for frustum culling.

getBlendOrderAt

fun getBlendOrderAt(instance: EntityInstance, primitiveIndex: Int): Int

Gets the drawing order for blended primitives.

getChannel

fun getChannel(instance: EntityInstance): Int

Get the channel a renderable is associated to.

getEnabledAttributesAt

fun getEnabledAttributesAt(instance: EntityInstance, primitiveIndex: Int): Set<VertexBuffer.VertexAttribute>

Retrieves the set of enabled attribute slots in the given primitive's VertexBuffer.

getEntity

fun getEntity(i: EntityInstance): Entity

Returns the Entity of the component from its Instance.

getFogEnabled

fun getFogEnabled(instance: EntityInstance): Boolean

Returns whether large-scale fog is enabled for this renderable.

getInstance

fun getInstance(e: Entity): EntityInstance

Gets a temporary handle that can be used to access the renderable state.

getInstanceCount

fun getInstanceCount(instance: EntityInstance): Int

Get the number of instances in the given entity.

getLayerMask

fun getLayerMask(instance: EntityInstance): Int

Get the visibility bits.

getLightChannel

fun getLightChannel(instance: EntityInstance, channel: Int): Boolean

Returns whether a light channel is enabled on this renderable.

getMaterialInstanceAt

fun getMaterialInstanceAt(instance: EntityInstance, primitiveIndex: Int): MaterialInstance?

Gets a material instance on a primitive.

getMorphTargetBuffer

fun getMorphTargetBuffer(instance: EntityInstance): MorphTargetBuffer?

Get the MorphTargetBuffer of the given renderable, or null if it has none.

getMorphTargetCount

fun getMorphTargetCount(instance: EntityInstance): Int

Get the number of morph targets in the given entity.

getPrimitiveCount

fun getPrimitiveCount(instance: EntityInstance): Int

Get the number of primitives in the given entity.

getPriority

fun getPriority(instance: EntityInstance): Int

Get the coarse-level draw ordering.

hasComponent

fun hasComponent(e: Entity): Boolean

Checks if the given entity already has a renderable component.

isCullingEnabled

fun isCullingEnabled(instance: EntityInstance): Boolean

Get whether or not frustum culling is on.

isGlobalBlendOrderEnabledAt

fun isGlobalBlendOrderEnabledAt(instance: EntityInstance, primitiveIndex: Int): Boolean

Gets whether the blend order is global or local to this Renderable.

isScreenSpaceContactShadowsEnabled

fun isScreenSpaceContactShadowsEnabled(instance: EntityInstance): Boolean

Checks if the renderable can use screen-space contact shadows.

isShadowCaster

fun isShadowCaster(instance: EntityInstance): Boolean

Checks if the renderable can cast shadows.

isShadowReceiver

fun isShadowReceiver(instance: EntityInstance): Boolean

Checks if the renderable can receive shadows.

setAxisAlignedBoundingBox

fun setAxisAlignedBoundingBox(instance: EntityInstance, aabb: Box)

Changes the bounding box used for frustum culling. The renderable must not have staticGeometry enabled.

setBlendOrderAt

fun setBlendOrderAt(instance: EntityInstance, primitiveIndex: Int, order: Int)

Sets the drawing order for blended primitives.

setBones

fun setBones(instance: EntityInstance, transforms: Array<RenderableManager.Bone>, boneCount: Int = transforms.size, offset: Int = 0)

fun setBones(instance: EntityInstance, transforms: FloatArray, boneCount: Int = transforms.size / 16, offset: Int = 0)

Updates the bone transforms in the range [offset, offset + boneCount). The bones must be pre-allocated using Builder.skinning().

setCastShadows

fun setCastShadows(instance: EntityInstance, enable: Boolean)

Changes whether or not the renderable casts shadows.

setChannel

fun setChannel(instance: EntityInstance, channel: Int)

Changes the channel a renderable is associated to.

setCulling

fun setCulling(instance: EntityInstance, enable: Boolean)

Changes whether or not frustum culling is on.

setFogEnabled

fun setFogEnabled(instance: EntityInstance, enable: Boolean)

Changes whether or not the large-scale fog is applied to this renderable.

setGeometryAt

fun setGeometryAt(instance: EntityInstance, primitiveIndex: Int, type: RenderableManager.PrimitiveType, vertices: VertexBuffer, offset: Int, count: Int)

Changes the geometry for a non-indexed primitive.

fun setGeometryAt(instance: EntityInstance, primitiveIndex: Int, type: RenderableManager.PrimitiveType, vertices: VertexBuffer, indices: IndexBuffer, offset: Int, count: Int)

Changes the geometry for a primitive.

setGlobalBlendOrderEnabledAt

fun setGlobalBlendOrderEnabledAt(instance: EntityInstance, primitiveIndex: Int, enabled: Boolean)

Sets whether the blend order is global or local to this Renderable.

setLayerMask

fun setLayerMask(instance: EntityInstance, select: Int, values: Int)

Changes the visibility bits.

setLightChannel

fun setLightChannel(instance: EntityInstance, channel: Int, enable: Boolean)

Enables or disables a light channel for this renderable.

setMaterialInstanceAt

fun setMaterialInstanceAt(instance: EntityInstance, primitiveIndex: Int, materialInstance: MaterialInstance)

Changes a material instance on a primitive.

setMorphTargetBufferOffsetAt

fun setMorphTargetBufferOffsetAt(instance: EntityInstance, level: Int, primitiveIndex: Int, offset: Int)

Associates a MorphTargetBuffer offset to the given primitive.

setMorphWeights

fun setMorphWeights(instance: EntityInstance, weights: FloatArray, offset: Int = 0)

Updates the vertex morphing weights on a renderable, all zeroes by default.

setPriority

fun setPriority(instance: EntityInstance, priority: Int)

Changes the coarse-level draw ordering.

setReceiveShadows

fun setReceiveShadows(instance: EntityInstance, enable: Boolean)

Changes whether or not the renderable can receive shadows.

setScreenSpaceContactShadows

fun setScreenSpaceContactShadows(instance: EntityInstance, enable: Boolean)

Changes whether or not the renderable can use screen-space contact shadows.

setSkinningBuffer

fun setSkinningBuffer(instance: EntityInstance, skinningBuffer: SkinningBuffer, count: Int, offset: Int)

Associates a region of a SkinningBuffer to a renderable instance.

RenderableManager

See also

Constructors

Types

Properties

Functions