Blender
V5.3
source
blender
io
spz
intern
spz_header.hh
Go to the documentation of this file.
1
/* SPDX-FileCopyrightText: 2026 Blender Authors
2
*
3
* SPDX-License-Identifier: GPL-2.0-or-later */
4
5
#pragma once
6
7
#include <cstdint>
8
#include <optional>
9
#include <string>
10
11
namespace
blender::io::spz
{
12
13
/* Bytes N, G, S, P in file order, shared by all format versions. */
14
constexpr
uint32_t
SPZ_HEADER_MAGIC
= 0x5053474e;
15
16
enum
HeaderFlag
{
17
SPZ_HEADER_ANTIALIASED
= 0x01,
18
SPZ_HEADER_HAS_EXTENSIONS
= 0x02,
19
};
20
21
/* Header inside the Gzip stream in SPZ versions 2 and 3. */
22
struct
PackedGaussiansHeader
{
23
uint32_t
magic
;
24
uint32_t
version
;
25
uint32_t
num_points
;
26
uint8_t
sh_degree
;
27
uint8_t
fractional_bits
;
28
uint8_t
flags
;
29
uint8_t
reserved
;
30
};
31
static_assert
(
sizeof
(
PackedGaussiansHeader
) == 16);
32
33
/* Uncompressed header in SPZ version 4. */
34
struct
NgspFileHeader
{
35
uint32_t
magic
;
36
uint32_t
version
;
37
uint32_t
num_points
;
38
uint8_t
sh_degree
;
39
uint8_t
fractional_bits
;
40
uint8_t
flags
;
41
uint8_t
num_streams
;
/* The number of ZSTD-compressed attribute streams (typically 6). */
42
uint32_t
toc_byte_offset
;
/* Byte offset from file start to the TOC. */
43
uint8_t
reserved
[12];
/* Zero, reserved for future use. */
44
};
45
static_assert
(
sizeof
(
NgspFileHeader
) == 32);
46
47
/* Return an error message for a header the importer cannot use, or nullopt on success.
48
* Only header fields are checked; this does not validate the file's payload or TOC entries. */
49
[[nodiscard]] std::optional<std::string>
check_header_for_errors
(
50
const
PackedGaussiansHeader
&header);
51
[[nodiscard]] std::optional<std::string>
check_header_for_errors
(
const
NgspFileHeader
&header);
52
53
}
// namespace blender::io::spz
blender::io::spz
Definition
spz_import.cc:33
blender::io::spz::HeaderFlag
HeaderFlag
Definition
spz_header.hh:16
blender::io::spz::SPZ_HEADER_ANTIALIASED
@ SPZ_HEADER_ANTIALIASED
Definition
spz_header.hh:17
blender::io::spz::SPZ_HEADER_HAS_EXTENSIONS
@ SPZ_HEADER_HAS_EXTENSIONS
Definition
spz_header.hh:18
blender::io::spz::check_header_for_errors
std::optional< std::string > check_header_for_errors(const PackedGaussiansHeader &header)
Definition
spz_header.cc:41
blender::io::spz::SPZ_HEADER_MAGIC
constexpr uint32_t SPZ_HEADER_MAGIC
Definition
spz_header.hh:14
blender::uint32_t
unsigned int uint32_t
Definition
BKE_text.h:81
blender::uint8_t
unsigned char uint8_t
Definition
BKE_text.h:79
blender::io::spz::NgspFileHeader
Definition
spz_header.hh:34
blender::io::spz::NgspFileHeader::fractional_bits
uint8_t fractional_bits
Definition
spz_header.hh:39
blender::io::spz::NgspFileHeader::version
uint32_t version
Definition
spz_header.hh:36
blender::io::spz::NgspFileHeader::sh_degree
uint8_t sh_degree
Definition
spz_header.hh:38
blender::io::spz::NgspFileHeader::num_streams
uint8_t num_streams
Definition
spz_header.hh:41
blender::io::spz::NgspFileHeader::magic
uint32_t magic
Definition
spz_header.hh:35
blender::io::spz::NgspFileHeader::toc_byte_offset
uint32_t toc_byte_offset
Definition
spz_header.hh:42
blender::io::spz::NgspFileHeader::reserved
uint8_t reserved[12]
Definition
spz_header.hh:43
blender::io::spz::NgspFileHeader::num_points
uint32_t num_points
Definition
spz_header.hh:37
blender::io::spz::NgspFileHeader::flags
uint8_t flags
Definition
spz_header.hh:40
blender::io::spz::PackedGaussiansHeader
Definition
spz_header.hh:22
blender::io::spz::PackedGaussiansHeader::flags
uint8_t flags
Definition
spz_header.hh:28
blender::io::spz::PackedGaussiansHeader::num_points
uint32_t num_points
Definition
spz_header.hh:25
blender::io::spz::PackedGaussiansHeader::sh_degree
uint8_t sh_degree
Definition
spz_header.hh:26
blender::io::spz::PackedGaussiansHeader::fractional_bits
uint8_t fractional_bits
Definition
spz_header.hh:27
blender::io::spz::PackedGaussiansHeader::magic
uint32_t magic
Definition
spz_header.hh:23
blender::io::spz::PackedGaussiansHeader::reserved
uint8_t reserved
Definition
spz_header.hh:29
blender::io::spz::PackedGaussiansHeader::version
uint32_t version
Definition
spz_header.hh:24
Generated on
for Blender by
doxygen
1.18.0