Record Class XRVersion

java.lang.Object

java.lang.Record

club.doki7.openxr.XRVersion

public record XRVersion(@Unsigned int major, @Unsigned int minor, @Unsigned int patch)
extends Record

Utility class for encoding/decoding OpenXR API versions

Field Summary

Fields

Modifier and Type	Field	Description
static final XRVersion	XR_API_VERSION_1_0
static final XRVersion	XR_API_VERSION_1_1

Constructor Summary

Constructors

Constructor	Description
XRVersion(int major, int minor, int patch)	Creates an instance of a XRVersion record class.

Method Summary

Modifier and Type	Method	Description
static XRVersion	decode(long version)
long	encode()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	major()	Returns the value of the major record component.
int	minor()	Returns the value of the minor record component.
int	patch()	Returns the value of the patch record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

XR_API_VERSION_1_0

public static final XRVersion XR_API_VERSION_1_0

XR_API_VERSION_1_1

public static final XRVersion XR_API_VERSION_1_1

Constructor Details

XRVersion

public XRVersion(@Unsigned
 int major,
 @Unsigned
 int minor,
 @Unsigned
 int patch)

Creates an instance of a XRVersion record class.

Parameters:

major - the value for the major record component

minor - the value for the minor record component

patch - the value for the patch record component

Method Details

decode

public static XRVersion decode(@Unsigned
 long version)

encode

@Unsigned
public long encode()

#define XR_MAKE_VERSION(major, minor, patch) \
    ((((major) & 0xffffULL) << 48) | (((minor) & 0xffffULL) << 32) | ((patch) & 0xffffffffULL))

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

major

@Unsigned
public int major()

Returns the value of the major record component.

Returns:

the value of the major record component

minor

@Unsigned
public int minor()

Returns the value of the minor record component.

Returns:

the value of the minor record component

patch

@Unsigned
public int patch()

Returns the value of the patch record component.

Returns:

the value of the patch record component