uvgformat::uvgFrame Struct Reference

User-facing point cloud frame. More...

#include <uvgFrame.hpp>

Collaboration diagram for uvgformat::uvgFrame:

Public Attributes
size_t	frameNumber = 0
	Sequential frame index from the input filename or application counter.
std::string	sourcePath
	Path to the source file; empty if the frame was not loaded from disk.
uvgFramePayload	payload
	The active point cloud payload (geometry + optional attributes).

Detailed Description

User-facing point cloud frame.

Contains the raw point cloud payload (geometry, optional attributes) plus lightweight metadata. This type is created by the application (e.g., via loadPly()) and passed to the encoder via API::encodeFrame(). The encoder holds a shared_ptr to the frame for the duration of processing — no data is copied.

frameNumber and sourcePath are informational and do not affect encoding.

Member Data Documentation

frameNumber

size_t uvgformat::uvgFrame::frameNumber = 0

Sequential frame index from the input filename or application counter.

payload

uvgFramePayload uvgformat::uvgFrame::payload

The active point cloud payload (geometry + optional attributes).

sourcePath

std::string uvgformat::uvgFrame::sourcePath

Path to the source file; empty if the frame was not loaded from disk.

---

The documentation for this struct was generated from the following file:

• src/libuvgformat/include/uvgformat/uvgFrame.hpp