Struct SceneUpdate

Struct Documentation

struct SceneUpdate

An update to the entities displayed in a 3D scene.

Public Functions

FoxgloveError encode(uint8_t *ptr, size_t len, size_t *encoded_len)

Encoded the SceneUpdate as protobuf to the provided buffer.

On success, writes the serialized length to *encoded_len. If the provided buffer has insufficient capacity, writes the required capacity to *encoded_len and returns FoxgloveError::BufferTooShort. If the message cannot be encoded, writes the reason to stderr and returns FoxgloveError::EncodeError.

Parameters:

  • ptr – the destination buffer. must point to at least len valid bytes.

  • len – the length of the destination buffer.

  • encoded_len – where the serialized length or required capacity will be written to.

Public Members

std::vector<SceneEntityDeletion> deletions

Scene entities to delete.

std::vector<SceneEntity> entities

Scene entities to add or replace.

Public Static Functions

static Schema schema()

Get the SceneUpdate schema.

The schema data returned is statically allocated.