Cauldron3D.Net.Scene (Cauldron3D.Net v0.3.3)

A scene browsers watch: it keeps everything sent to it (CauldronGPU.Host.Record) so a browser that joins later gets the whole scene, and broadcasts each batch to the browsers already watching as CauldronGPU.Stream bytes.

{:ok, scene} = Cauldron3D.Net.Scene.open(id: "courtyard", events: self())
cube = Cauldron3D.Net.Scene.mesh(scene, CauldronGPU.Mesh.cube(1.0))
Cauldron3D.Net.Scene.submit(scene, [{:instance, 1, %CauldronGPU.Instance{mesh: cube}}])

A scene is a CauldronGPU.Target, so the converters (CauldronGPU.Bsp.upload/4 and the rest) upload to it as they do to a renderer. Changes are CauldronGPU.Stream changes. Meshes, textures and materials are kept until release/2. Input from a browser arrives at the :events pid as {:cauldron_3d_net, scene_id, session, event}, session a reference for the browser and event shaped as CauldronGPU's window events, plus :joined and :left.

open/1 starts the scene linked to the caller; start_link/1 is the same for a supervisor, and lookup/1 finds a started scene by id.

Summary

Types

t()

Functions

canvas(scene, canvas)

Makes a canvas and returns its handle, a texture's.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

event(scene, session, event)

Passes a browser's event to the scene's :events pid.

lookup(id)

The scene started as id, or nil.

material(scene, material)

Defines a material and returns its handle.

mesh(scene, mesh)

Uploads a mesh and returns its handle.

open(opts)

Starts a scene. Options: :id (a string, required), :events (a pid, default none).

release(scene, handle)

Lets the scene drop a mesh, texture or material once no scene entry uses it.

snapshot(scene)

The bytes that give a browser the whole scene as it stands.

start_link(opts)

Starts a scene as open/1 does, answering its pid, for a supervisor.

submit(scene, changes)

Sends one tick of changes to every watching browser and keeps them for later ones.

texture(scene, texture)

Uploads a texture and returns its handle.

topic(id)

The PubSub topic a scene's batches are broadcast on.