Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanSpecializationMapEntry

java.lang.Object

com.io7m.jcoronado.api.VulkanSpecializationMapEntry

All Implemented Interfaces:

VulkanSpecializationMapEntryType

public final class VulkanSpecializationMapEntry
extends java.lang.Object
implements VulkanSpecializationMapEntryType

See Also:

"VkSpecializationMapEntry"

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VulkanSpecializationMapEntry.Builder	Builds instances of type VulkanSpecializationMapEntry.

Method Summary

Modifier and Type	Method	Description
static VulkanSpecializationMapEntry.Builder	builder()	Creates a builder for VulkanSpecializationMapEntry.
int	constantID()
static VulkanSpecializationMapEntry	copyOf(VulkanSpecializationMapEntryType instance)	Creates an immutable copy of a VulkanSpecializationMapEntryType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanSpecializationMapEntry that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: constantID, offset, size.
static VulkanSpecializationMapEntry	of(int constantID, long offset, long size)	Construct a new immutable VulkanSpecializationMapEntry instance.
long	offset()
long	size()
java.lang.String	toString()	Prints the immutable value VulkanSpecializationMapEntry with attribute values.
VulkanSpecializationMapEntry	withConstantID(int value)	Copy the current immutable object by setting a value for the constantID attribute.
VulkanSpecializationMapEntry	withOffset(long value)	Copy the current immutable object by setting a value for the offset attribute.
VulkanSpecializationMapEntry	withSize(long value)	Copy the current immutable object by setting a value for the size attribute.

Methods inherited from class java.lang.Object

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

Method Detail

constantID

public int constantID()

Specified by:

constantID in interface VulkanSpecializationMapEntryType

Returns:

The ID of the specialization constant in SPIR-V.

offset

public long offset()

Specified by:

offset in interface VulkanSpecializationMapEntryType

Returns:

The byte offset of the specialization constant value within the supplied data buffer.

size

public long size()

Specified by:

size in interface VulkanSpecializationMapEntryType

Returns:

The byte size of the specialization constant value within the supplied data buffer.

withConstantID

public final VulkanSpecializationMapEntry withConstantID(int value)

Copy the current immutable object by setting a value for the constantID attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for constantID

Returns:

A modified copy of the this object

withOffset

public final VulkanSpecializationMapEntry withOffset(long value)

Copy the current immutable object by setting a value for the offset attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for offset

Returns:

A modified copy of the this object

withSize

public final VulkanSpecializationMapEntry withSize(long value)

Copy the current immutable object by setting a value for the size attribute. A value equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for size

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanSpecializationMapEntry that have equal attribute values.

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: constantID, offset, size.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanSpecializationMapEntry with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanSpecializationMapEntry of(int constantID,
                                              long offset,
                                              long size)

Construct a new immutable VulkanSpecializationMapEntry instance.

Parameters:

constantID - The value for the constantID attribute

offset - The value for the offset attribute

size - The value for the size attribute

Returns:

An immutable VulkanSpecializationMapEntry instance

copyOf

public static VulkanSpecializationMapEntry copyOf(VulkanSpecializationMapEntryType instance)

Creates an immutable copy of a VulkanSpecializationMapEntryType value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Parameters:

instance - The instance to copy

Returns:

A copied immutable VulkanSpecializationMapEntry instance

builder

public static VulkanSpecializationMapEntry.Builder builder()

Creates a builder for VulkanSpecializationMapEntry.

Returns:

A new VulkanSpecializationMapEntry builder