VoxelBuffer

public void Clear();

Erases all contents of the buffer and resets its size to zero. Channel depths and default values are preserved.

public void ClearVoxelMetadata();

Erases all per-voxel metadata.

public void ClearVoxelMetadataInArea(Vector3I minPos, Vector3I maxPos);

Erases per-voxel metadata within the specified area.

public void CompressUniformChannels();

Finds channels that have the same value in all their voxels, and reduces memory usage by storing only one value instead. This is effective for example when large parts of the terrain are filled with air.

public void CopyChannelFrom(VoxelBuffer other, uint channel);

Copies all values from the channel of another VoxelBuffer into the same channel for the current buffer. The depth formats must match.

public void CopyChannelFromArea(VoxelBuffer other, Vector3I srcMin, Vector3I srcMax, Vector3I dstMin, uint channel);

Copies values from a channel's sub-region of another VoxelBuffer into the same channel for the current buffer, at a specific location. The depth formats must match. If corners of the area represent a negative-size area, they will be sorted back. If coordinates are entirely or partially out of bounds, they will be clipped automatically. Copying across the same buffer to overlapping areas is not supported. You may use an intermediary buffer in this case.

public void CopyVoxelMetadataInArea(VoxelBuffer srcBuffer, Vector3I srcMinPos, Vector3I srcMaxPos, Vector3I dstMinPos);

Copies per-voxel metadata from a sub-region of another VoxelBuffer into the the current buffer, at a specific location. Values will be a shallow copy. If corners of the area represent a negative-size area, they will be sorted back. If coordinates are entirely or partially out of bounds, they will be clipped automatically. Copying across the same buffer to overlapping areas is not supported. You may use an intermediary buffer in this case.

public void Create(int sx, int sy, int sz);

Clears the buffer and gives it the specified size.

public ImageTexture3D Create3DTextureFromSdfZxy(Image.Format outputFormat);

Creates a 3D texture from the SDF channel. If output_format is a 8-bit pixel format, the texture will contain normalized signed distances, where 0.5 is the isolevel, 0 is the furthest away under surface, and 1 is the furthest away above surface. Only 16-bit SDF channel is supported. Only Image.Format.R8 and Image.Format.L8 output formats are suported. Note: when sampling this texture in a shader, you need to swizzle 3D coordinates with .yxz. This is how voxels are internally stored, and this function does not change this convention.

public Reckfell.Collections.Array<Image> DebugPrintSdfYSlices(float scale = 1f);

Renders the contents of the SDF channel into images where blue gradients are negative values (below surface) and yellow gradients are positive (above surface). Each image corresponds to an XZ slice of the buffer. The scale parameter can be used to change contrast of images by scaling the SDF.

public void DecompressChannel(int channel);

If the given channel is currently compressed, decompresses it so that all voxel values are individually stored in full. This will use more memory.

public void DownscaleTo(VoxelBuffer dst, Vector3I srcMin, Vector3I srcMax, Vector3I dstMin);

Produces a downscaled version of this buffer, by a factor of 2, without any form of interpolation (i.e using nearest-neighbor). Metadata is not copied.

public void Fill(ulong value, int channel = 0);

Fills one channel of this buffer with a specific raw value.

public void FillArea(ulong value, Vector3I min, Vector3I max, uint channel = 0);

Fills an area of a channel in this buffer with a specific raw value.

public void FillAreaF(float value, Vector3I min, Vector3I max, uint channel);

Fills an area of a channel in this buffer with a specific SDF value.

public void FillF(float value, int channel = 0);

Fills one channel of this buffer with a specific SDF value.

public void ForEachVoxelMetadata(Callable callback);

Executes a function on every voxel in this buffer which have associated metadata. The function's arguments must be (position: Vector3i, metadata: Variant). IMPORTANT: inserting new or removing metadata from inside this function is not allowed.

public void ForEachVoxelMetadataInArea(Callable callback, Vector3I minPos, Vector3I maxPos);

Executes a function on every voxel in this buffer which have associated metadata, within the specified area. IMPORTANT: inserting new or removing metadata from inside this function is not allowed.

public VoxelBuffer.Allocator GetAllocator();

Gets which memory allocator is used by this buffer.

public Variant GetBlockMetadata();

Gets metadata associated to this VoxelBuffer.

public byte[] GetChannelAsByteArray(VoxelBuffer.ChannelId channelIndex);

Gets voxel data from a channel as uncompressed raw bytes. Check VoxelBuffer.Depth for information about the data format. Note: if the channel is compressed, it will be decompressed on the fly into the returned array. If you want a different behavior in this case, check VoxelBuffer.GetChannelCompression before calling this method.

public VoxelBuffer.Compression GetChannelCompression(int channel);

Gets which compression mode the specified channel has.

public VoxelBuffer.Depth GetChannelDepth(uint channel);

Gets which bit depth the specified channel has.

public Vector3I GetSize();

Gets the 3D size of the buffer in voxels.

public ulong GetVoxel(int x, int y, int z, uint channel = 0);

Gets the raw value of a voxel within this buffer.

public float GetVoxelF(int x, int y, int z, uint channel = 0);

Gets the float value of a voxel within this buffer. You may use this function if you work with SDF volumes (smooth voxels).

public Variant GetVoxelMetadata(Vector3I pos);

Gets the metadata attached to a specific voxel in this buffer.

public VoxelTool GetVoxelTool();

Constructs a VoxelTool instance bound to this buffer. This provides access to some extra common functions.

public ulong GetVoxelV(Vector3I pos, uint channel = 0);

Gets the raw value of a voxel within this buffer.

public bool IsUniform(int channel);

Checks if every voxel within a channel has the same value.

public void Mirror(Vector3I.Axis axis);

Mirrors voxel values along the specified axis.

public void OpAddBufferF(VoxelBuffer other, VoxelBuffer.ChannelId channel);

Computes the sum of corresponding voxels between the current buffer and the other buffer, and stores the result in the current buffer. Voxels are interpreted as signed distances (usually the VoxelBuffer.ChannelId.ChannelSdf channel).

public void OpMaxBufferF(VoxelBuffer other, VoxelBuffer.ChannelId channel);

Computes the maximum of corresponding voxels between the current buffer and the other buffer, and stores the result in the current buffer. Voxels are interpreted as signed distances (usually the VoxelBuffer.ChannelId.ChannelSdf channel).

public void OpMinBufferF(VoxelBuffer other, VoxelBuffer.ChannelId channel);

Computes the minimum of corresponding voxels between the current buffer and the other buffer, and stores the result in the current buffer. Voxels are interpreted as signed distances (usually the VoxelBuffer.ChannelId.ChannelSdf channel).

public void OpMulBufferF(VoxelBuffer other, VoxelBuffer.ChannelId channel);

Computes the multiplication of corresponding voxels between the current buffer and the other buffer, and stores the result in the current buffer. Voxels are interpreted as signed distances (usually the VoxelBuffer.ChannelId.ChannelSdf channel).

public void OpMulValueF(float other, VoxelBuffer.ChannelId channel);

Multiplies every voxels in the buffer by the given value. Voxels are interpreted as signed distances (usually the VoxelBuffer.ChannelId.ChannelSdf channel).

public void OpSelectLessSrcFDstIValues(VoxelBuffer src, VoxelBuffer.ChannelId srcChannel, float threshold, int valueIfLess, int valueIfMore, VoxelBuffer.ChannelId dstChannel);

For every voxel in the source buffer, if the value is lower than a threshold, set the corresponding voxel in the current buffer to a specific integer value, or another value otherwise. Voxels in the source buffer are interpreted as signed distances (usually the VoxelBuffer.ChannelId.ChannelSdf channel).

public void OpSubBufferF(VoxelBuffer other, VoxelBuffer.ChannelId channel);

Computes the subtraction of corresponding voxels between the current buffer and the other buffer (current - other), and stores the result in the current buffer. Voxels are interpreted as signed distances (usually the VoxelBuffer.ChannelId.ChannelSdf channel).

public void RemapValues(uint channel, int[] map);

Remaps integer values in a channel using the passed map lookup table. Each index in map corresponds to an original value, and will be replaced by map[original].

public void RemapValues(uint channel, ReadOnlySpan<int> map);

Remaps integer values in a channel using the passed map lookup table. Each index in map corresponds to an original value, and will be replaced by map[original].

public void Rotate90(Vector3I.Axis axis, int turns);

Rotates voxel values by 90 degrees along the specified axis. 1 turn is 90 degrees, 2 turns is 180 degrees, 3 turns is 270 degrees (or -90), 4 turns does nothing. Negative turns go in the other direction. This may also rotate the size of the buffer, if it isn't cubic.

public void SetBlockMetadata(Variant meta);

Sets arbitrary data on this buffer. Old data is replaced. Note, this is separate storage from per-voxel metadata. If this VoxelBuffer is saved, this metadata will also be saved along voxels, so make sure the data supports serialization (i.e you can't put nodes or arbitrary objects in it).

public void SetChannelDepth(uint channel, VoxelBuffer.Depth depth);

Changes the bit depth of a given channel. This controls the range of values a channel can hold. See VoxelBuffer.Depth for more information.

public void SetChannelFromByteArray(VoxelBuffer.ChannelId channelIndex, byte[] data);

Overwrites the contents of a channel from raw voxel data. Check VoxelBuffer.Depth for information about the expected data format.

public void SetChannelFromByteArray(VoxelBuffer.ChannelId channelIndex, ReadOnlySpan<byte> data);

Overwrites the contents of a channel from raw voxel data. Check VoxelBuffer.Depth for information about the expected data format.

public void SetVoxel(ulong value, int x, int y, int z, uint channel = 0);

Sets the raw value of a voxel. If you use smooth voxels, you may prefer using VoxelBuffer.SetVoxelF.

public void SetVoxelF(float value, int x, int y, int z, uint channel = 0);

Sets the float value of a voxel. This method should be used if you work on SDF data (smooth voxels).

public void SetVoxelMetadata(Vector3I pos, Variant value);

Attaches arbitrary data on a specific voxel. Old data is replaced. Passing null will erase metadata. If this VoxelBuffer is saved, this metadata will also be saved along voxels, so make sure the data supports serialization (i.e you can't put nodes or arbitrary objects in it).

public void Update3DTextureFromSdfZxy(ImageTexture3D existingTexture);

Updates an existing 3D texture from the SDF channel. See VoxelBuffer.Create3DTextureFromSdfZxy for more information.

public const long MaxSize = 65535;

Maximum size a buffer can have when serialized. Buffers that contain uniform-compressed voxels can reach it, but in practice, the limit is much lower and depends on available memory.