binary_points.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Povl Filip Sonne-Frederiksen
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
// RUXP v1 — the binary point transport served by
// `GET /api/v1/clouds/{name}/points?format=binary` (#283).
//
// The byte layout is normative in docs/gui/binary-points.md; this header is the
// C++ side of that contract and must not drift from it. The client side is
// apps/rux/frontend/src/viewport/binaryPoints.ts.
//
// Deliberately framework-free, like the rest of gui/api.hpp: a page of storage
// records in, a buffer out.
 
// ProjectDB is included rather than forward-declared: the page type this
// header takes is the nested ProjectDB::CloudPage, which needs the complete
// class. ProjectDB.hpp is itself forward-declaration-disciplined (STANDARDS
// §2) — it pulls in the PCL point types and nothing heavier.
#include <reusex/core/ProjectDB.hpp>
 
#include <cstddef>
#include <cstdint>
#include <string_view>
#include <vector>
 
namespace rux::gui {

inline constexpr uint16_t kRuxpVersion = 1;

inline constexpr size_t kRuxpHeaderBase = 40;
inline constexpr size_t kRuxpFieldSize = 16;

inline constexpr uint32_t kRuxpFlagLod = 0x1U;

inline constexpr uint32_t kRuxpKnownFlags = kRuxpFlagLod;

enum class RuxpType : uint8_t { f32 = 1, u8 = 2, u32 = 3 };

std::vector<uint8_t> encode_ruxp(const reusex::ProjectDB::CloudPage &page,
                                 uint32_t flags = 0);

bool ruxp_supports(std::string_view point_type);
 
} // namespace rux::gui