filament/io.github.erkko68.filament

Package-level declarations

Types

class Box(val center: FloatArray = FloatArray(3), val halfExtent: FloatArray = FloatArray(3))

An axis-aligned 3D box represented by its center and half-extent.

actual class BufferObject

A generic GPU buffer for storing data.

expect class BufferObject

A generic GPU buffer for storing data.

actual class BufferObject(jsBufferObject: BufferObject)

A generic GPU buffer for storing data.

actual class BufferObject

A generic GPU buffer for storing data.

actual class BufferObject

A generic GPU buffer for storing data.

actual class Camera

Camera represents the eye(s) through which the scene is viewed.

expect class Camera

Camera represents the eye(s) through which the scene is viewed.

actual class Camera(jsCamera: Camera, _entity: Entity = 0)

Camera represents the eye(s) through which the scene is viewed.

actual class Camera

Camera represents the eye(s) through which the scene is viewed.

actual class Camera

Camera represents the eye(s) through which the scene is viewed.

actual class ColorGrading

ColorGrading is used to transform (modify or correct) the colors of the HDR buffer.

expect class ColorGrading

ColorGrading is used to transform (modify or correct) the colors of the HDR buffer.

actual class ColorGrading(jsColorGrading: ColorGrading)

ColorGrading is used to transform (modify or correct) the colors of the HDR buffer.

actual class ColorGrading

ColorGrading is used to transform (modify or correct) the colors of the HDR buffer.

actual class ColorGrading

ColorGrading is used to transform (modify or correct) the colors of the HDR buffer.

actual object Colors

Utilities for color space conversions and color temperature calculations.

expect object Colors

Utilities for color space conversions and color temperature calculations.

actual object Colors

Utilities for color space conversions and color temperature calculations.

actual object Colors

Utilities for color space conversions and color temperature calculations.

actual object Colors

Utilities for color space conversions and color temperature calculations.

actual class Engine

Engine is Filament's main entry-point.

expect class Engine

Engine is Filament's main entry-point.

actual class Engine

Engine is Filament's main entry-point.

actual class Engine

Engine is Filament's main entry-point.

actual class Engine

Engine is Filament's main entry-point.

typealias Entity = Int

An Entity is an opaque 32-bit identifier for objects in the scene.

typealias EntityInstance = Int

An EntityInstance is an opaque 32-bit identifier representing a component instance.

actual class EntityManager

Manages entity creation, destruction, and lifecycle.

expect class EntityManager

Manages entity creation, destruction, and lifecycle.

actual class EntityManager(jsEntityManager: EntityManager)

Manages entity creation, destruction, and lifecycle.

actual class EntityManager

Manages entity creation, destruction, and lifecycle.

actual class EntityManager

Manages entity creation, destruction, and lifecycle.

actual class Fence

Fence is used to synchronize the application main thread with filament's rendering thread.

expect class Fence

Fence is used to synchronize the application main thread with filament's rendering thread.

actual class Fence

Fence is used to synchronize the application main thread with filament's rendering thread.

actual class Fence

Fence is used to synchronize the application main thread with filament's rendering thread.

actual class Fence

Fence is used to synchronize the application main thread with filament's rendering thread.

actual object Filament

Filament is the main module initialization singleton.

expect object Filament

Filament is the main module initialization singleton.

actual object Filament

Filament is the main module initialization singleton.

actual object Filament

Filament is the main module initialization singleton.

actual object Filament

Filament is the main module initialization singleton.

actual class IndexBuffer

A buffer containing vertex indices into a VertexBuffer.

expect class IndexBuffer

A buffer containing vertex indices into a VertexBuffer.

actual class IndexBuffer(jsIndexBuffer: IndexBuffer, val indexCount: Int = 0)

A buffer containing vertex indices into a VertexBuffer.

actual class IndexBuffer

A buffer containing vertex indices into a VertexBuffer.

actual class IndexBuffer

A buffer containing vertex indices into a VertexBuffer.

actual class IndirectLight

IndirectLight simulates environment lighting, a form of global illumination.

expect class IndirectLight

IndirectLight simulates environment lighting, a form of global illumination.

actual class IndirectLight

IndirectLight simulates environment lighting, a form of global illumination.

actual class IndirectLight

IndirectLight simulates environment lighting, a form of global illumination.

actual class IndirectLight

IndirectLight simulates environment lighting, a form of global illumination.

actual class LightManager

LightManager allows you to create light sources in the scene.

expect class LightManager

LightManager allows you to create light sources in the scene.

actual class LightManager(jsLightManager: LightManager)

LightManager allows you to create light sources in the scene.

actual class LightManager

LightManager allows you to create light sources in the scene.

actual class LightManager

LightManager allows you to create light sources in the scene.

actual class Material

Material defines the visual appearance of a surface.

expect class Material

Material defines the visual appearance of a surface.

actual class Material

Material defines the visual appearance of a surface.

actual class Material

Material defines the visual appearance of a surface.

actual class Material

Material defines the visual appearance of a surface.

MaterialInstance

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

expect class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

actual class MaterialInstance

MaterialInstance customizes the parameters of a Material for per-object rendering.

MorphTargetBuffer

actual class MorphTargetBuffer

A container for vertex morphing data that supports both automatic and manual morphing.

expect class MorphTargetBuffer

A container for vertex morphing data that supports both automatic and manual morphing.

actual class MorphTargetBuffer

A container for vertex morphing data that supports both automatic and manual morphing.

actual class MorphTargetBuffer

A container for vertex morphing data that supports both automatic and manual morphing.

actual class MorphTargetBuffer

A container for vertex morphing data that supports both automatic and manual morphing.

actual class NativeSurface

Android implementation of NativeSurface, wrapping a Surface-like object.

expect class NativeSurface

A platform-agnostic representation of a display surface.

actual class NativeSurface

A platform-agnostic representation of a display surface.

actual class NativeSurface

JVM implementation of NativeSurface. Wraps a raw native-window/layer pointer (passed as a Long address, or a MemorySegment) handed to FilaEngine_createSwapChain as a void*.

actual class NativeSurface

Native implementation of NativeSurface, wrapping a raw pointer.

RenderableManager

actual class RenderableManager

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

expect class RenderableManager

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

actual class RenderableManager(jsRenderableManager: RenderableManager)

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

actual class RenderableManager

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

actual class RenderableManager

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

actual class Renderer

Renderer represents an operating system window and manages frame rendering and pacing.

expect class Renderer

Renderer represents an operating system window and manages frame rendering and pacing.

actual class Renderer

Renderer represents an operating system window and manages frame rendering and pacing.

actual class Renderer

Renderer represents an operating system window and manages frame rendering and pacing.

actual class Renderer

Renderer represents an operating system window and manages frame rendering and pacing.

actual class RenderTarget

An offscreen render target that can be associated with a View and contains weak references to a set of attached Texture objects.

expect class RenderTarget

An offscreen render target that can be associated with a View and contains weak references to a set of attached Texture objects.

actual class RenderTarget

An offscreen render target that can be associated with a View and contains weak references to a set of attached Texture objects.

actual class RenderTarget

An offscreen render target that can be associated with a View and contains weak references to a set of attached Texture objects.

actual class RenderTarget

An offscreen render target that can be associated with a View and contains weak references to a set of attached Texture objects.

actual class Scene

A Scene is a collection of Renderables and Lights to be rendered together.

expect class Scene

A Scene is a collection of Renderables and Lights to be rendered together.

actual class Scene(jsScene: Scene)

A Scene is a collection of Renderables and Lights to be rendered together.

actual class Scene

A Scene is a collection of Renderables and Lights to be rendered together.

actual class Scene

A Scene is a collection of Renderables and Lights to be rendered together.

actual class SkinningBuffer

SkinningBuffer is used to hold skinning data (bones) for skeletal animation.

expect class SkinningBuffer

SkinningBuffer is used to hold skinning data (bones) for skeletal animation.

actual class SkinningBuffer

SkinningBuffer is used to hold skinning data (bones) for skeletal animation.

actual class SkinningBuffer

SkinningBuffer is used to hold skinning data (bones) for skeletal animation.

actual class SkinningBuffer

SkinningBuffer is used to hold skinning data (bones) for skeletal animation.

actual class Skybox

Skybox renders a background environment cube around the camera.

expect class Skybox

Skybox renders a background environment cube around the camera.

actual class Skybox

Skybox renders a background environment cube around the camera.

actual class Skybox

Skybox renders a background environment cube around the camera.

actual class Skybox

Skybox renders a background environment cube around the camera.

actual class Stream

Stream is used to attach a video stream to a Filament Texture.

expect class Stream

Stream is used to attach a video stream to a Filament Texture.

actual class Stream(jsStream: Any?)

Stream is used to attach a video stream to a Filament Texture.

actual class Stream

Stream is used to attach a video stream to a Filament Texture.

actual class Stream

Stream is used to attach a video stream to a Filament Texture.

SurfaceOrientation

actual class SurfaceOrientation

The surface orientation helper can be used to populate Filament-style TANGENTS buffers.

expect class SurfaceOrientation

The surface orientation helper can be used to populate Filament-style TANGENTS buffers.

actual class SurfaceOrientation(jsSurfaceOrientation: SurfaceOrientation, val vertexCount: Int = 0)

The surface orientation helper can be used to populate Filament-style TANGENTS buffers.

actual class SurfaceOrientation

The surface orientation helper can be used to populate Filament-style TANGENTS buffers.

actual class SurfaceOrientation

The surface orientation helper can be used to populate Filament-style TANGENTS buffers.

actual class SwapChain

A SwapChain represents an Operating System's native renderable surface.

expect class SwapChain

A SwapChain represents an Operating System's native renderable surface.

actual class SwapChain(jsSwapChain: SwapChain)

A SwapChain represents an Operating System's native renderable surface.

actual class SwapChain

A SwapChain represents an Operating System's native renderable surface.

actual class SwapChain

A SwapChain represents an Operating System's native renderable surface.

actual class Texture

Texture represents a GPU texture resource.

expect class Texture

Texture represents a GPU texture resource.

actual class Texture

Texture represents a GPU texture resource.

actual class Texture

Texture represents a GPU texture resource.

actual class Texture

Texture represents a GPU texture resource.

actual class TextureSampler

TextureSampler defines how a texture is accessed during rendering.

expect class TextureSampler

TextureSampler defines how a texture is accessed during rendering.

actual class TextureSampler

TextureSampler defines how a texture is accessed during rendering.

actual class TextureSampler

TextureSampler defines how a texture is accessed during rendering.

actual class TextureSampler

TextureSampler defines how a texture is accessed during rendering.

actual open class ToneMapper

Interface for tone mapping operators.

expect open class ToneMapper

Interface for tone mapping operators.

actual open class ToneMapper

Interface for tone mapping operators.

actual open class ToneMapper

Interface for tone mapping operators.

actual open class ToneMapper

Interface for tone mapping operators.

TransformManager

actual class TransformManager

TransformManager allows managing transforms (4x4 matrices) for entities.

expect class TransformManager

TransformManager allows managing transforms (4x4 matrices) for entities.

actual class TransformManager(jsTransformManager: TransformManager)

TransformManager allows managing transforms (4x4 matrices) for entities.

actual class TransformManager

TransformManager allows managing transforms (4x4 matrices) for entities.

actual class TransformManager

TransformManager allows managing transforms (4x4 matrices) for entities.

actual class VertexBuffer

Holds a set of buffers that define the geometry of a Renderable.

expect class VertexBuffer

Holds a set of buffers that define the geometry of a Renderable.

actual class VertexBuffer(jsVertexBuffer: VertexBuffer, val vertexCount: Int = 0)

Holds a set of buffers that define the geometry of a Renderable.

actual class VertexBuffer

Holds a set of buffers that define the geometry of a Renderable.

actual class VertexBuffer

Holds a set of buffers that define the geometry of a Renderable.

actual class View

A View encompasses all the state needed for rendering a Scene.

expect class View

A View encompasses all the state needed for rendering a Scene.

actual class View(jsView: View)

A View encompasses all the state needed for rendering a Scene.

actual class View

A View encompasses all the state needed for rendering a Scene.

actual class View

A View encompasses all the state needed for rendering a Scene.

class Viewport(var left: Int = 0, var bottom: Int = 0, var width: Int = 0, var height: Int = 0)

Viewport specifies the rectangular region where a View's Scene is rendered.

Properties

const val NULL_ENTITY: Entity = 0

A special Entity value representing no entity (null).

Functions

fun FloatArray.toBytes(): ByteArray

Convert a FloatArray to a ByteArray in native byte order.

fun IntArray.toBytes(): ByteArray

Convert an IntArray to a ByteArray in native byte order.

fun ShortArray.toBytes(): ByteArray

Convert a ShortArray to a ByteArray in native byte order.