Class SerializedBitArrayUtilities

Serialisation of BitArray, Utility class

Inheritance

object

SerializedBitArrayUtilities

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.Rendering

Assembly: Unity.RenderPipelines.Core.Editor.dll

Syntax

public static class SerializedBitArrayUtilities

Methods

ToSerializeBitArray128(SerializedProperty)

Convert to 128bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static SerializedBitArray128 ToSerializeBitArray128(this SerializedProperty serializedProperty)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty

Returns

Type	Description
SerializedBitArray128	A SerializedBitArray128

ToSerializeBitArray16(SerializedProperty)

Convert to 16bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static SerializedBitArray16 ToSerializeBitArray16(this SerializedProperty serializedProperty)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty

Returns

Type	Description
SerializedBitArray16	A SerializedBitArray16

ToSerializeBitArray256(SerializedProperty)

Convert to 256bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static SerializedBitArray256 ToSerializeBitArray256(this SerializedProperty serializedProperty)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty

Returns

Type	Description
SerializedBitArray256	A SerializedBitArray256

ToSerializeBitArray32(SerializedProperty)

Convert to 32bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static SerializedBitArray32 ToSerializeBitArray32(this SerializedProperty serializedProperty)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty

Returns

Type	Description
SerializedBitArray32	A SerializedBitArray32

ToSerializeBitArray64(SerializedProperty)

Convert to 64bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static SerializedBitArray64 ToSerializeBitArray64(this SerializedProperty serializedProperty)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty

Returns

Type	Description
SerializedBitArray64	A SerializedBitArray64

ToSerializeBitArray8(SerializedProperty)

Convert to 8bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static SerializedBitArray8 ToSerializeBitArray8(this SerializedProperty serializedProperty)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty

Returns

Type	Description
SerializedBitArray8	A SerializedBitArray8

ToSerializedBitArray(SerializedProperty)

Construct a SerializedBitArrayAny of appropriate size

Declaration

public static SerializedBitArrayAny ToSerializedBitArray(this SerializedProperty serializedProperty)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty

Returns

Type	Description
SerializedBitArrayAny	A SerializedBitArrayAny

Remarks

Note that this variant doesn't properly support editing multiple targets, especially if there are several BitArrays on the target objects.

ToSerializedBitArray(SerializedProperty, SerializedObject[])

Construct a SerializedBitArrayAny of appropriate size

Declaration

public static SerializedBitArrayAny ToSerializedBitArray(this SerializedProperty serializedProperty, SerializedObject[] targetSerializedObjects)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedObject[]	targetSerializedObjects	An individual SerializedObject for each targetObject

Returns

Type	Description
SerializedBitArrayAny	A SerializedBitArrayAny

TryGetSerializeBitArray128(SerializedProperty, out SerializedBitArray128)

Try convert to 128bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static bool TryGetSerializeBitArray128(this SerializedProperty serializedProperty, out SerializedBitArray128 serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedBitArray128	serializedBitArray	Out SerializedBitArray128

Returns

Type	Description
bool	True if convertion was a success

TryGetSerializeBitArray16(SerializedProperty, out SerializedBitArray16)

Try convert to 16bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static bool TryGetSerializeBitArray16(this SerializedProperty serializedProperty, out SerializedBitArray16 serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedBitArray16	serializedBitArray	Out SerializedBitArray16

Returns

Type	Description
bool	True if convertion was a success

TryGetSerializeBitArray256(SerializedProperty, out SerializedBitArray256)

Try convert to 256bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static bool TryGetSerializeBitArray256(this SerializedProperty serializedProperty, out SerializedBitArray256 serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedBitArray256	serializedBitArray	Out SerializedBitArray256

Returns

Type	Description
bool	True if convertion was a success

TryGetSerializeBitArray32(SerializedProperty, out SerializedBitArray32)

Try convert to 32bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static bool TryGetSerializeBitArray32(this SerializedProperty serializedProperty, out SerializedBitArray32 serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedBitArray32	serializedBitArray	Out SerializedBitArray32

Returns

Type	Description
bool	True if convertion was a success

TryGetSerializeBitArray64(SerializedProperty, out SerializedBitArray64)

Try convert to 64bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static bool TryGetSerializeBitArray64(this SerializedProperty serializedProperty, out SerializedBitArray64 serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedBitArray64	serializedBitArray	Out SerializedBitArray64

Returns

Type	Description
bool	True if convertion was a success

TryGetSerializeBitArray8(SerializedProperty, out SerializedBitArray8)

Try convert to 8bit

Declaration

[Obsolete("Since SerializedBitArray unification, only use SerializedBitArrayAny. #from(23.2)")]
public static bool TryGetSerializeBitArray8(this SerializedProperty serializedProperty, out SerializedBitArray8 serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedBitArray8	serializedBitArray	Out SerializedBitArray8

Returns

Type	Description
bool	True if convertion was a success

TryGetSerializedBitArray(SerializedProperty, out SerializedBitArrayAny)

Try to construct a SerializedBitArray of appropriate size

Declaration

public static bool TryGetSerializedBitArray(this SerializedProperty serializedProperty, out SerializedBitArrayAny serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedBitArrayAny	serializedBitArray	Out SerializedBitArray

Returns

Type	Description
bool	True if construction was successful

Remarks

Note that this variant doesn't properly support editing multiple targets, especially if there are several BitArrays on the target objects.

TryGetSerializedBitArray(SerializedProperty, SerializedObject[], out SerializedBitArrayAny)

Try to construct a SerializedBitArray of appropriate size

Declaration

public static bool TryGetSerializedBitArray(this SerializedProperty serializedProperty, SerializedObject[] targetSerializedObjects, out SerializedBitArrayAny serializedBitArray)

Parameters

Type	Name	Description
SerializedProperty	serializedProperty	The SerializedProperty
SerializedObject[]	targetSerializedObjects	An individual SerializedObject for each targetObject
SerializedBitArrayAny	serializedBitArray	Out SerializedBitArray

Returns

Type	Description
bool	True if construction was successful