Struct SnapshotDynamicBuffersHelper
Helper class for managing ghost buffers data. Internal use only.
Inherited Members
Namespace: Unity.NetCode
Assembly: Unity.NetCode.dll
Syntax
public struct SnapshotDynamicBuffersHelperMethods
CalculateBufferCapacity(uint, out uint)
Return the history buffer capacity and the resulting size of each history buffer slot necessary to store the given dynamic data size.
Declaration
public static uint CalculateBufferCapacity(uint dynamicDataSize, out uint slotSize)Parameters
| Type | Name | Description |
|---|---|---|
| uint | dynamicDataSize | Dynamic data size |
| uint | slotSize | Slot size |
Returns
| Type | Description |
|---|---|
| uint | History buffer capacity |
GetDynamicDataCapacity(uint, int)
Return the currently available space (masks + buffer data) available in each slot.
Declaration
public static uint GetDynamicDataCapacity(uint headerSize, int length)Parameters
| Type | Name | Description |
|---|---|---|
| uint | headerSize | Header size |
| int | length | Length |
Returns
| Type | Description |
|---|---|
| uint | The currently available space (masks + buffer data) available in each slot |
GetDynamicDataChangeMaskSize(int, int)
Compute the size of the bitmask for the given number of elements and mask bits. The size is aligned to 16 bytes.
Declaration
public static int GetDynamicDataChangeMaskSize(int changeMaskBits, int numElements)Parameters
| Type | Name | Description |
|---|---|---|
| int | changeMaskBits | Change mask bits |
| int | numElements | Number of elements |
Returns
| Type | Description |
|---|---|
| int | Size of bitmask |
GetDynamicDataPtr(byte*, int, int)
Retrieve the dynamic buffer history slot pointer
Declaration
public static byte* GetDynamicDataPtr(byte* dynamicDataBuffer, int historyPosition, int bufferLength)Parameters
| Type | Name | Description |
|---|---|---|
| byte* | dynamicDataBuffer | Dynamic data buffer |
| int | historyPosition | history position in buffer |
| int | bufferLength | Length of buffer |
Returns
| Type | Description |
|---|---|
| byte* | pointer to dynamic buffer |
Exceptions
| Type | Condition |
|---|---|
| IndexOutOfRangeException | Thrown if the position is invalid |
| InvalidOperationException | Thrown if bufferlength is less than headersize |
GetHeaderSize()
Get the size of the header at the beginning of the dynamic snapshot buffer. The size of the header is constant.
Declaration
public static uint GetHeaderSize()Returns
| Type | Description |
|---|---|
| uint | Size of the header at the beginning of the dynamic snapshot buffer |