EntropyCanvas::SceneRoot

EntropyCanvas::SceneRoot

Scene root component - marks an entity as the root of a scene. More…

#include <Scene.h>

Public Functions

	Name
	ENTROPY_REGISTER_TYPE(SceneRoot )
	ENTROPY_FIELD(std::string , sceneName )
	ENTROPY_FIELD(std::string , ownerAppId )
virtual	ENTROPY_FIELD(uint64_t , ownerSessionId ) =0
	ENTROPY_FIELD(bool , enabled )
	ENTROPY_FIELD(bool , transient )
	ENTROPY_FIELD(bool , isDefaultScene )

Detailed Description

struct EntropyCanvas::SceneRoot;

Scene root component - marks an entity as the root of a scene.

The scene root entity defines the scene’s properties and lifecycle. A scene can be:

• Enabled: Entities are rendered and processed
• Disabled: Entities are NOT rendered or processed, but CAN still receive updates
• Transient: Deleted when the owning session disconnects (any reason: graceful, crash, timeout)
• Persistent: Saved to USD storage, survives app disconnect

Every SDK app automatically gets a default transient scene on connect. Portal clients are special and don’t get a default scene.

Public Functions Documentation

function ENTROPY_REGISTER_TYPE

ENTROPY_REGISTER_TYPE(
    SceneRoot
)

function ENTROPY_FIELD

ENTROPY_FIELD(
    std::string ,
    sceneName
)

function ENTROPY_FIELD

ENTROPY_FIELD(
    std::string ,
    ownerAppId
)

function ENTROPY_FIELD

virtual ENTROPY_FIELD(
    uint64_t ,
    ownerSessionId
) =0

function ENTROPY_FIELD

ENTROPY_FIELD(
    bool ,
    enabled
)

function ENTROPY_FIELD

ENTROPY_FIELD(
    bool ,
    transient
)

function ENTROPY_FIELD

ENTROPY_FIELD(
    bool ,
    isDefaultScene
)

---

Updated on 2026-01-26 at 17:14:35 -0500