- java.lang.Object
-
- com.io7m.jcoronado.api.VulkanImageSubresourceLayers
-
- All Implemented Interfaces:
VulkanImageSubresourceLayersType
public final class VulkanImageSubresourceLayers extends java.lang.Object implements VulkanImageSubresourceLayersType
Structure specifying a image subresource layers.- See Also:
- "VkImageSubresourceLayers"
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VulkanImageSubresourceLayers.Builder
Builds instances of typeVulkanImageSubresourceLayers
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Set<VulkanImageAspectFlag>
aspectMask()
int
baseArrayLayer()
static VulkanImageSubresourceLayers.Builder
builder()
Creates a builder forVulkanImageSubresourceLayers
.static VulkanImageSubresourceLayers
copyOf(VulkanImageSubresourceLayersType instance)
Creates an immutable copy of aVulkanImageSubresourceLayersType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVulkanImageSubresourceLayers
that have equal attribute values.int
hashCode()
Computes a hash code from attributes:aspectMask
,mipLevel
,baseArrayLayer
,layerCount
.int
layerCount()
int
mipLevel()
static VulkanImageSubresourceLayers
of(java.lang.Iterable<VulkanImageAspectFlag> aspectMask, int mipLevel, int baseArrayLayer, int layerCount)
Construct a new immutableVulkanImageSubresourceLayers
instance.static VulkanImageSubresourceLayers
of(java.util.Set<VulkanImageAspectFlag> aspectMask, int mipLevel, int baseArrayLayer, int layerCount)
Construct a new immutableVulkanImageSubresourceLayers
instance.java.lang.String
toString()
Prints the immutable valueVulkanImageSubresourceLayers
with attribute values.VulkanImageSubresourceLayers
withAspectMask(VulkanImageAspectFlag... elements)
Copy the current immutable object with elements that replace the content ofaspectMask
.VulkanImageSubresourceLayers
withAspectMask(java.lang.Iterable<VulkanImageAspectFlag> elements)
Copy the current immutable object with elements that replace the content ofaspectMask
.VulkanImageSubresourceLayers
withBaseArrayLayer(int value)
Copy the current immutable object by setting a value for thebaseArrayLayer
attribute.VulkanImageSubresourceLayers
withLayerCount(int value)
Copy the current immutable object by setting a value for thelayerCount
attribute.VulkanImageSubresourceLayers
withMipLevel(int value)
Copy the current immutable object by setting a value for themipLevel
attribute.
-
-
-
Method Detail
-
aspectMask
public java.util.Set<VulkanImageAspectFlag> aspectMask()
- Specified by:
aspectMask
in interfaceVulkanImageSubresourceLayersType
- Returns:
- a combination of flags selecting the color, depth, and/or stencil aspects to be copied.
-
mipLevel
public int mipLevel()
- Specified by:
mipLevel
in interfaceVulkanImageSubresourceLayersType
- Returns:
- The mipmap level to copy from.
-
baseArrayLayer
public int baseArrayLayer()
- Specified by:
baseArrayLayer
in interfaceVulkanImageSubresourceLayersType
- Returns:
- The starting layer to copy.
-
layerCount
public int layerCount()
- Specified by:
layerCount
in interfaceVulkanImageSubresourceLayersType
- Returns:
- The number of layers to copy.
-
withAspectMask
public final VulkanImageSubresourceLayers withAspectMask(VulkanImageAspectFlag... elements)
Copy the current immutable object with elements that replace the content ofaspectMask
.- Parameters:
elements
- The elements to set- Returns:
- A modified copy of
this
object
-
withAspectMask
public final VulkanImageSubresourceLayers withAspectMask(java.lang.Iterable<VulkanImageAspectFlag> elements)
Copy the current immutable object with elements that replace the content ofaspectMask
. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
elements
- An iterable of aspectMask elements to set- Returns:
- A modified copy of
this
object
-
withMipLevel
public final VulkanImageSubresourceLayers withMipLevel(int value)
Copy the current immutable object by setting a value for themipLevel
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for mipLevel- Returns:
- A modified copy of the
this
object
-
withBaseArrayLayer
public final VulkanImageSubresourceLayers withBaseArrayLayer(int value)
Copy the current immutable object by setting a value for thebaseArrayLayer
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for baseArrayLayer- Returns:
- A modified copy of the
this
object
-
withLayerCount
public final VulkanImageSubresourceLayers withLayerCount(int value)
Copy the current immutable object by setting a value for thelayerCount
attribute. A value equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for layerCount- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)
This instance is equal to all instances ofVulkanImageSubresourceLayers
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:aspectMask
,mipLevel
,baseArrayLayer
,layerCount
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueVulkanImageSubresourceLayers
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
public static VulkanImageSubresourceLayers of(java.util.Set<VulkanImageAspectFlag> aspectMask, int mipLevel, int baseArrayLayer, int layerCount)
Construct a new immutableVulkanImageSubresourceLayers
instance.- Parameters:
aspectMask
- The value for theaspectMask
attributemipLevel
- The value for themipLevel
attributebaseArrayLayer
- The value for thebaseArrayLayer
attributelayerCount
- The value for thelayerCount
attribute- Returns:
- An immutable VulkanImageSubresourceLayers instance
-
of
public static VulkanImageSubresourceLayers of(java.lang.Iterable<VulkanImageAspectFlag> aspectMask, int mipLevel, int baseArrayLayer, int layerCount)
Construct a new immutableVulkanImageSubresourceLayers
instance.- Parameters:
aspectMask
- The value for theaspectMask
attributemipLevel
- The value for themipLevel
attributebaseArrayLayer
- The value for thebaseArrayLayer
attributelayerCount
- The value for thelayerCount
attribute- Returns:
- An immutable VulkanImageSubresourceLayers instance
-
copyOf
public static VulkanImageSubresourceLayers copyOf(VulkanImageSubresourceLayersType instance)
Creates an immutable copy of aVulkanImageSubresourceLayersType
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 VulkanImageSubresourceLayers instance
-
builder
public static VulkanImageSubresourceLayers.Builder builder()
Creates a builder forVulkanImageSubresourceLayers
.- Returns:
- A new VulkanImageSubresourceLayers builder
-
-