Source 2 Viewer

Appearance

Download Source 2 Viewer

Class VoxelVisibility ​

Namespace: ValveResourceFormat.Blocks
Assembly: ValveResourceFormat.dll

"VXVS" block. Three layouts, differing in how space is cut into clusters:

, latest: an octree that dices each leaf into a 4x4x4 grid of cells, where every cluster reaching that leaf owns a 64 bit mask of the cells it covers.

, until 2022: an octree whose leaves list boxes, each box tagged with the cluster that owns it.

, until 2018: a binary tree of arbitrary split planes, where a leaf is a cluster outright and nothing subdivides it further.

csharp
public class VoxelVisibility : Block, IWorldVisibility

Inheritance ​

object ← Block ← VoxelVisibility

Implements ​

IWorldVisibility

Inherited Members ​

Block.Type, Block.Offset, Block.Size, Block.Resource, Block.Read(BinaryReader), Block.ToString(), Block.WriteText(IndentedTextWriter), Block.Serialize(Stream)

Extension Methods ​

ResourceDataExtensions.AsKeyValueCollection(Block)

Fields ​

ClusterBitfieldWords ​

The number of 32 bit words in a cluster bitfield.

csharp
public const int ClusterBitfieldWords = 128

Field Value ​

int

MaxClusters ​

The maximum number of clusters a visibility query can report.

csharp
public const int MaxClusters = 4096

Field Value ​

int

Properties ​

BaseClusterCount ​

Gets the number of visibility clusters.

csharp
public uint BaseClusterCount { get; }

Property Value ​

uint

ClusterBitfieldWordCount ​

Gets how many 32 bit words a cluster bitfield needs.

csharp
public int ClusterBitfieldWordCount { get; }

Property Value ​

int

ClusterCount ​

Gets the number of clusters, excluding any rows stored past them.

csharp
public int ClusterCount { get; }

Property Value ​

int

EnclosedClusterList ​

Gets the enclosed cluster list entries.

csharp
public (int Offset, int Count)[] EnclosedClusterList { get; }

Property Value ​

(int Offset, int Count)[]

EnclosedClusters ​

Gets the enclosed cluster ids.

csharp
public ushort[] EnclosedClusters { get; }

Property Value ​

ushort[]

GridSize ​

Gets the grid cell size.

csharp
public float GridSize { get; }

Property Value ​

float

HasVisibilityData ​

Gets whether this block holds visibility that can be queried. Files from before the octree format, and maps compiled without visibility, have none.

csharp
public bool HasVisibilityData { get; }

Property Value ​

bool

Masks ​

Gets the spatial occupancy masks.

csharp
public ulong[] Masks { get; }

Property Value ​

ulong[]

MaxBounds ​

Gets the maximum bounds of the octree.

csharp
public Vector3 MaxBounds { get; }

Property Value ​

Vector3

MinBounds ​

Gets the minimum bounds of the octree.

csharp
public Vector3 MinBounds { get; }

Property Value ​

Vector3

Nodes ​

Gets the octree nodes.

csharp
public VoxelVisibility.Node[] Nodes { get; }

Property Value ​

VoxelVisibility.Node[]

PVSBytesPerCluster ​

Gets the number of PVS bytes per cluster.

csharp
public uint PVSBytesPerCluster { get; }

Property Value ​

uint

RegionBoxTree ​

Gets the region box tree this file holds instead, or null when it uses the mask octree. Everything else on this class stays empty when it is set.

csharp
public RegionBoxVoxelVisibility? RegionBoxTree { get; }

Property Value ​

RegionBoxVoxelVisibility?

Regions ​

Gets the region entries.

csharp
public VoxelVisibility.Region[] Regions { get; }

Property Value ​

VoxelVisibility.Region[]

SkyVisibility ​

Gets the visibility row listing the clusters the sky reaches, empty when there is no sky row.

csharp
public ReadOnlyMemory<byte> SkyVisibility { get; }

Property Value ​

ReadOnlyMemory<byte>

SkyVisibilityCluster ​

Gets the cluster index used for sky visibility.

csharp
public uint SkyVisibilityCluster { get; }

Property Value ​

uint

SunVisibility ​

Gets the visibility row listing the clusters sunlight reaches, empty when there is no sun row. Nothing outside it can be lit by the sun, so nothing outside it casts a sun shadow.

csharp
public ReadOnlyMemory<byte> SunVisibility { get; }

Property Value ​

ReadOnlyMemory<byte>

SunVisibilityCluster ​

Gets the cluster index used for sun visibility.

csharp
public uint SunVisibilityCluster { get; }

Property Value ​

uint

Type ​

Gets the block type.

csharp
public override BlockType Type { get; }

Property Value ​

BlockType

VisBlocks ​

Gets the raw PVS bit table.

csharp
public byte[] VisBlocks { get; }

Property Value ​

byte[]

Methods ​

BuildClusterChildBounds() ​

Builds a list of bounding boxes for each cluster.

csharp
public Dictionary<ushort, List<(Vector3 Min, Vector3 Max)>> BuildClusterChildBounds()

Returns ​

Dictionary<ushort, List<(Vector3 Min, Vector3 Max)>>

GetClusterForPosition(Vector3) ​

Gets the cluster id for a given world-space position, falling back to the first cluster within half a grid cell of it, or -1 when there is none.

csharp
public int GetClusterForPosition(Vector3 position)

Parameters ​

position Vector3

Returns ​

int

GetPVSForPoint(Vector3) ​

Gets the PVS bitfield for the cluster(s) at the given point, or null if there is none.

csharp
public byte[]? GetPVSForPoint(Vector3 point)

Parameters ​

point Vector3

Returns ​

byte[]?

GetVisClusterList(Vector3, Vector3, Span<ushort>, bool) ​

Writes the id of every cluster the given box overlaps.

csharp
public int GetVisClusterList(Vector3 min, Vector3 max, Span<ushort> clusters, bool exact = false)

Parameters ​

min Vector3

Minimum corner of the box.

max Vector3

Maximum corner of the box.

clusters Span<ushort>

Destination for the cluster ids. When more clusters overlap than fit, the result collapses to the catch-all cluster 0 instead of an arbitrary subset.

exact bool

Visit every leaf rather than taking the precomputed cluster list of a fully enclosed octree node.

Returns ​

int

The number of cluster ids written.

GetVisClustersForBox(Vector3, Vector3, Span<uint>, bool) ​

Fills a bitfield with every cluster the given box overlaps, one bit per cluster id.

csharp
public void GetVisClustersForBox(Vector3 min, Vector3 max, Span<uint> clusterBits, bool exact = false)

Parameters ​

min Vector3

Minimum corner of the box.

max Vector3

Maximum corner of the box.

clusterBits Span<uint>

Destination bitfield, at least words long.

exact bool

Visit every leaf rather than taking the precomputed cluster list of a fully enclosed octree node.

GetVisibilityRowForPoint(Vector3) ​

Gets the visibility row seen from a point, or an empty row when there is none to cull with.

csharp
public ReadOnlyMemory<byte> GetVisibilityRowForPoint(Vector3 point)

Parameters ​

point Vector3

World-space point.

Returns ​

ReadOnlyMemory<byte>

Remarks ​

A point no region claims, or one outside the octree, sees every cluster.

GetWorldVisibility(Resource) ​

Gets the world visibility a resource holds, whichever of the three layouts it was written in, or null when it holds none that can be queried. An octree of two clusters or fewer counts as none and culls nothing.

csharp
public static IWorldVisibility? GetWorldVisibility(Resource resource)

Parameters ​

resource Resource

A .vvis_c resource.

Returns ​

IWorldVisibility?

Read(BinaryReader) ​

Reads the block data from a binary reader.

csharp
public override void Read(BinaryReader reader)

Parameters ​

reader BinaryReader

The binary reader to read from.

Serialize(Stream) ​

Writes the binary representation of the object to Stream.

csharp
public override void Serialize(Stream stream)

Parameters ​

stream Stream

Stream.

WriteText(IndentedTextWriter) ​

Writes the correct text dump of the object to .

csharp
public override void WriteText(IndentedTextWriter writer)

Parameters ​

writer IndentedTextWriter

.

See Also ​

https://s2v.app/SchemaExplorer/cs2/worldrenderer/CVoxelVisibility

This project is not affiliated with Valve Software. Source 2 is a trademark and/or registered trademark of Valve Corporation.