Struct Binary.CodeBookIndex
Denotes an index into the list of codebooks contained in the runtime asset.
Namespace: Unity.Kinematica
Syntax
public struct CodeBookIndexProperties
Invalid
Invalid codebook index.
Declaration
public static Binary.CodeBookIndex Invalid { get; }Property Value
| Type | Description |
|---|---|
| Binary.CodeBookIndex |
IsValid
Determines if the given codebook index is valid or not.
Declaration
public bool IsValid { get; }Property Value
| Type | Description |
|---|---|
| Boolean | True if the codebook index is valid; false otherwise. |
Methods
Equals(Binary.CodeBookIndex)
Determines whether two codebook indices are equal.
Declaration
public bool Equals(Binary.CodeBookIndex codeBookIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Binary.CodeBookIndex | codeBookIndex | The index to compare against the current index. |
Returns
| Type | Description |
|---|---|
| Boolean | True if the specified index is equal to the current index; otherwise, false. |
Operators
Implicit(Int32 to Binary.CodeBookIndex)
Implicit conversion from an integer value to a codebook index.
Declaration
public static implicit operator Binary.CodeBookIndex(int codeBookIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Int32 | codeBookIndex |
Returns
| Type | Description |
|---|---|
| Binary.CodeBookIndex |
Implicit(Binary.CodeBookIndex to Int32)
Implicit conversion from a codebook index to an integer value.
Declaration
public static implicit operator int (Binary.CodeBookIndex codeBookIndex)Parameters
| Type | Name | Description |
|---|---|---|
| Binary.CodeBookIndex | codeBookIndex |
Returns
| Type | Description |
|---|---|
| Int32 |