Struct GhostComponentSerializer

Mostly for internal use. A collection helper functions used by code-gen and some runtime systems. See GhostSendSystem, GhostReceiveSystem, and others. To work with ghost snapshots, see SnapshotData and SnapshotDynamicDataBuffer. It also declares all the ghost component/buffers serializers delegate methods, that are used to register (at runtime) the code-generated serializers (to the GhostComponentSerializer.State collection).

Inherited Members
Namespace: Unity.NetCode.LowLevel.Unsafe
Syntax
public struct GhostComponentSerializer

Methods

ChangeMaskArraySizeInBytes(Int32)

Compute the number of bytes necessary to encode the required number of bits

Declaration
public static int ChangeMaskArraySizeInBytes(int numBits)
Parameters
Type Name Description
Int32 numBits
Returns
Type Description
Int32

The min number of bytes to store this number of bits, rounded to the nearest 4 bytes (for data-alignment).

ChangeMaskArraySizeInUInts(Int32)

Compute the number of uint necessary to encode the required number of bits

Declaration
public static int ChangeMaskArraySizeInUInts(int numBits)
Parameters
Type Name Description
Int32 numBits
Returns
Type Description
Int32

The uint mask to encode this number of bits.

ConvertToUnsafeList(IntPtr, Int32)

Helper method to construct an UnsafeList<T> from a given IntPtr and length.

Declaration
public static UnsafeList<float> ConvertToUnsafeList(IntPtr floatData, int len)
Parameters
Type Name Description
IntPtr floatData
Int32 len
Returns
Type Description
UnsafeList<Single>

CopyFromChangeMask(IntPtr, Int32, Int32)

Extract from the source buffer an unsigned integer, representing a portion of a bitmask starting from the given offset and number of bits.

Declaration
public static uint CopyFromChangeMask(IntPtr bitData, int offset, int numBits)
Parameters
Type Name Description
IntPtr bitData
Int32 offset
Int32 numBits
Returns
Type Description
UInt32

CopyToChangeMask(IntPtr, UInt32, Int32, Int32)

For internal use only, copy the src bitmask to a destination buffer, to the given offset and for the required number of bits.

Declaration
public static void CopyToChangeMask(IntPtr bitData, uint src, int offset, int numBits)
Parameters
Type Name Description
IntPtr bitData
UInt32 src
Int32 offset
Int32 numBits

IntPtrCast<T>(ref T)

Return a pointer to the memory address for the given value instance.

Declaration
public static IntPtr IntPtrCast<T>(ref T value)
    where T : struct
Parameters
Type Name Description
T value
Returns
Type Description
IntPtr
Type Parameters
Name Description
T

SizeInSnapshot(in GhostComponentSerializer.State)

Helper that returns the size in bytes (aligned to 16 bytes boundary) used to store the component data inside SnapshotData.

Declaration
public static int SizeInSnapshot(in GhostComponentSerializer.State serializer)
Parameters
Type Name Description
GhostComponentSerializer.State serializer
Returns
Type Description
Int32
Remarks

For buffers in particular, the SnapshotData contains only offset and length information (the buffer data resides inside the SnapshotDynamicDataBuffer), and the reported size is always equal to the Unity.NetCode.GhostSystemConstants.DynamicBufferComponentSnapshotSize.

SnapshotSizeAligned(Int32)

Align the give size to 16 byte boundary.

Declaration
public static int SnapshotSizeAligned(int size)
Parameters
Type Name Description
Int32 size
Returns
Type Description
Int32

SnapshotSizeAligned(UInt32)

Align the give size to 16 byte boundary

Declaration
public static uint SnapshotSizeAligned(uint size)
Parameters
Type Name Description
UInt32 size
Returns
Type Description
UInt32

TypeCast<T>(IntPtr, Int32)

Helper method to get a reference to a struct data from its address in memory.

Declaration
public static ref T TypeCast<T>(IntPtr value, int offset = 0)
    where T : struct
Parameters
Type Name Description
IntPtr value
Int32 offset
Returns
Type Description
T
Type Parameters
Name Description
T