Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanPushConstantRange

java.lang.Object

com.io7m.jcoronado.api.VulkanPushConstantRange

All Implemented Interfaces:

VulkanPushConstantRangeType

public final class VulkanPushConstantRange
extends java.lang.Object
implements VulkanPushConstantRangeType

Structure specifying a push constant range.

See Also:

"VkPushConstantRange"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VulkanPushConstantRange.Builder	builder()	Creates a builder for VulkanPushConstantRange.
static VulkanPushConstantRange	copyOf(VulkanPushConstantRangeType instance)	Creates an immutable copy of a VulkanPushConstantRangeType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanPushConstantRange that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: stageFlags, offset, size.
static VulkanPushConstantRange	of(java.lang.Iterable<VulkanShaderStageFlag> stageFlags, int offset, int size)	Construct a new immutable VulkanPushConstantRange instance.
static VulkanPushConstantRange	of(java.util.Set<VulkanShaderStageFlag> stageFlags, int offset, int size)	Construct a new immutable VulkanPushConstantRange instance.
int	offset()
int	size()
java.util.Set<VulkanShaderStageFlag>	stageFlags()
java.lang.String	toString()	Prints the immutable value VulkanPushConstantRange with attribute values.
VulkanPushConstantRange	withOffset(int value)	Copy the current immutable object by setting a value for the offset attribute.
VulkanPushConstantRange	withSize(int value)	Copy the current immutable object by setting a value for the size attribute.
VulkanPushConstantRange	withStageFlags(VulkanShaderStageFlag... elements)	Copy the current immutable object with elements that replace the content of stageFlags.
VulkanPushConstantRange	withStageFlags(java.lang.Iterable<VulkanShaderStageFlag> elements)	Copy the current immutable object with elements that replace the content of stageFlags.

Methods inherited from class java.lang.Object

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

Method Detail

stageFlags

public java.util.Set<VulkanShaderStageFlag> stageFlags()

Specified by:

stageFlags in interface VulkanPushConstantRangeType

Returns:

The stages that will access the range of push constants

offset

public int offset()

Specified by:

offset in interface VulkanPushConstantRangeType

Returns:

The start of the range

size

public int size()

Specified by:

size in interface VulkanPushConstantRangeType

Returns:

The size of the range

withStageFlags

public final VulkanPushConstantRange withStageFlags(VulkanShaderStageFlag... elements)

Copy the current immutable object with elements that replace the content of stageFlags.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withStageFlags

public final VulkanPushConstantRange withStageFlags(java.lang.Iterable<VulkanShaderStageFlag> elements)

Copy the current immutable object with elements that replace the content of stageFlags. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of stageFlags elements to set

Returns:

A modified copy of this object

withOffset

public final VulkanPushConstantRange withOffset(int 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 VulkanPushConstantRange withSize(int 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 VulkanPushConstantRange 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: stageFlags, offset, size.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanPushConstantRange with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanPushConstantRange of(java.util.Set<VulkanShaderStageFlag> stageFlags,
                                         int offset,
                                         int size)

Construct a new immutable VulkanPushConstantRange instance.

Parameters:

stageFlags - The value for the stageFlags attribute

offset - The value for the offset attribute

size - The value for the size attribute

Returns:

An immutable VulkanPushConstantRange instance

of

public static VulkanPushConstantRange of(java.lang.Iterable<VulkanShaderStageFlag> stageFlags,
                                         int offset,
                                         int size)

Construct a new immutable VulkanPushConstantRange instance.

Parameters:

stageFlags - The value for the stageFlags attribute

offset - The value for the offset attribute

size - The value for the size attribute

Returns:

An immutable VulkanPushConstantRange instance

copyOf

public static VulkanPushConstantRange copyOf(VulkanPushConstantRangeType instance)

Creates an immutable copy of a VulkanPushConstantRangeType 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 VulkanPushConstantRange instance

builder

public static VulkanPushConstantRange.Builder builder()

Creates a builder for VulkanPushConstantRange.

Returns:

A new VulkanPushConstantRange builder