Module com.io7m.jcoronado.api
Package com.io7m.jcoronado.api
Class VulkanVertexInputBindingDescription
- java.lang.Object
-
- com.io7m.jcoronado.api.VulkanVertexInputBindingDescription
-
- All Implemented Interfaces:
VulkanVertexInputBindingDescriptionType
public final class VulkanVertexInputBindingDescription extends java.lang.Object implements VulkanVertexInputBindingDescriptionType
Structure specifying vertex input binding description.- See Also:
- "VkVertexInputBindingDescription"
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VulkanVertexInputBindingDescription.Builder
Builds instances of typeVulkanVertexInputBindingDescription
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
binding()
static VulkanVertexInputBindingDescription.Builder
builder()
Creates a builder forVulkanVertexInputBindingDescription
.static VulkanVertexInputBindingDescription
copyOf(VulkanVertexInputBindingDescriptionType instance)
Creates an immutable copy of aVulkanVertexInputBindingDescriptionType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVulkanVertexInputBindingDescription
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:binding
,stride
,inputRate
.VulkanVertexInputRate
inputRate()
static VulkanVertexInputBindingDescription
of(int binding, int stride, VulkanVertexInputRate inputRate)
Construct a new immutableVulkanVertexInputBindingDescription
instance.int
stride()
java.lang.String
toString()
Prints the immutable valueVulkanVertexInputBindingDescription
with attribute values.VulkanVertexInputBindingDescription
withBinding(int value)
Copy the current immutable object by setting a value for thebinding
attribute.VulkanVertexInputBindingDescription
withInputRate(VulkanVertexInputRate value)
Copy the current immutable object by setting a value for theinputRate
attribute.VulkanVertexInputBindingDescription
withStride(int value)
Copy the current immutable object by setting a value for thestride
attribute.
-
-
-
Method Detail
-
binding
public int binding()
- Specified by:
binding
in interfaceVulkanVertexInputBindingDescriptionType
- Returns:
- The binding number that this structure describes.
-
stride
public int stride()
- Specified by:
stride
in interfaceVulkanVertexInputBindingDescriptionType
- Returns:
- The distance in bytes between two consecutive elements within the buffer.
-
inputRate
public VulkanVertexInputRate inputRate()
- Specified by:
inputRate
in interfaceVulkanVertexInputBindingDescriptionType
- Returns:
- Specifies whether vertex attribute addressing is a function of the vertex index or of the instance index.
-
withBinding
public final VulkanVertexInputBindingDescription withBinding(int value)
Copy the current immutable object by setting a value for thebinding
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for binding- Returns:
- A modified copy of the
this
object
-
withStride
public final VulkanVertexInputBindingDescription withStride(int value)
Copy the current immutable object by setting a value for thestride
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for stride- Returns:
- A modified copy of the
this
object
-
withInputRate
public final VulkanVertexInputBindingDescription withInputRate(VulkanVertexInputRate value)
Copy the current immutable object by setting a value for theinputRate
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for inputRate- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)
This instance is equal to all instances ofVulkanVertexInputBindingDescription
that have equal attribute values.- Overrides:
equals
in classjava.lang.Object
- Returns:
true
ifthis
is equal toanother
instance
-
hashCode
public int hashCode()
Computes a hash code from attributes:binding
,stride
,inputRate
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueVulkanVertexInputBindingDescription
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
public static VulkanVertexInputBindingDescription of(int binding, int stride, VulkanVertexInputRate inputRate)
Construct a new immutableVulkanVertexInputBindingDescription
instance.- Parameters:
binding
- The value for thebinding
attributestride
- The value for thestride
attributeinputRate
- The value for theinputRate
attribute- Returns:
- An immutable VulkanVertexInputBindingDescription instance
-
copyOf
public static VulkanVertexInputBindingDescription copyOf(VulkanVertexInputBindingDescriptionType instance)
Creates an immutable copy of aVulkanVertexInputBindingDescriptionType
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 VulkanVertexInputBindingDescription instance
-
builder
public static VulkanVertexInputBindingDescription.Builder builder()
Creates a builder forVulkanVertexInputBindingDescription
.- Returns:
- A new VulkanVertexInputBindingDescription builder
-
-