- java.lang.Object
-
- com.io7m.jcoronado.api.VulkanImageCopy
-
- All Implemented Interfaces:
VulkanImageCopyType
public final class VulkanImageCopy extends java.lang.Object implements VulkanImageCopyType
Structure specifying an image copy operation.- See Also:
- "VkImageCopy"
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VulkanImageCopy.Builder
Builds instances of typeVulkanImageCopy
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VulkanImageCopy.Builder
builder()
Creates a builder forVulkanImageCopy
.static VulkanImageCopy
copyOf(VulkanImageCopyType instance)
Creates an immutable copy of aVulkanImageCopyType
value.boolean
equals(java.lang.Object another)
This instance is equal to all instances ofVulkanImageCopy
that have equal attribute values.VulkanExtent3D
extent()
int
hashCode()
Computes a hash code from attributes:sourceSubresource
,sourceOffset
,targetSubresource
,targetOffset
,extent
.static VulkanImageCopy
of(VulkanImageSubresourceLayers sourceSubresource, VulkanOffset3D sourceOffset, VulkanImageSubresourceLayers targetSubresource, VulkanOffset3D targetOffset, VulkanExtent3D extent)
Construct a new immutableVulkanImageCopy
instance.VulkanOffset3D
sourceOffset()
VulkanImageSubresourceLayers
sourceSubresource()
VulkanOffset3D
targetOffset()
VulkanImageSubresourceLayers
targetSubresource()
java.lang.String
toString()
Prints the immutable valueVulkanImageCopy
with attribute values.VulkanImageCopy
withExtent(VulkanExtent3D value)
Copy the current immutable object by setting a value for theextent
attribute.VulkanImageCopy
withSourceOffset(VulkanOffset3D value)
Copy the current immutable object by setting a value for thesourceOffset
attribute.VulkanImageCopy
withSourceSubresource(VulkanImageSubresourceLayers value)
Copy the current immutable object by setting a value for thesourceSubresource
attribute.VulkanImageCopy
withTargetOffset(VulkanOffset3D value)
Copy the current immutable object by setting a value for thetargetOffset
attribute.VulkanImageCopy
withTargetSubresource(VulkanImageSubresourceLayers value)
Copy the current immutable object by setting a value for thetargetSubresource
attribute.
-
-
-
Method Detail
-
sourceSubresource
public VulkanImageSubresourceLayers sourceSubresource()
- Specified by:
sourceSubresource
in interfaceVulkanImageCopyType
- Returns:
- The subresource to copy from
-
sourceOffset
public VulkanOffset3D sourceOffset()
- Specified by:
sourceOffset
in interfaceVulkanImageCopyType
- Returns:
- The offset of the source region
-
targetSubresource
public VulkanImageSubresourceLayers targetSubresource()
- Specified by:
targetSubresource
in interfaceVulkanImageCopyType
- Returns:
- The subresource to copy to
-
targetOffset
public VulkanOffset3D targetOffset()
- Specified by:
targetOffset
in interfaceVulkanImageCopyType
- Returns:
- The offset of the target region
-
extent
public VulkanExtent3D extent()
- Specified by:
extent
in interfaceVulkanImageCopyType
- Returns:
- The extent of the copied region
-
withSourceSubresource
public final VulkanImageCopy withSourceSubresource(VulkanImageSubresourceLayers value)
Copy the current immutable object by setting a value for thesourceSubresource
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for sourceSubresource- Returns:
- A modified copy of the
this
object
-
withSourceOffset
public final VulkanImageCopy withSourceOffset(VulkanOffset3D value)
Copy the current immutable object by setting a value for thesourceOffset
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for sourceOffset- Returns:
- A modified copy of the
this
object
-
withTargetSubresource
public final VulkanImageCopy withTargetSubresource(VulkanImageSubresourceLayers value)
Copy the current immutable object by setting a value for thetargetSubresource
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for targetSubresource- Returns:
- A modified copy of the
this
object
-
withTargetOffset
public final VulkanImageCopy withTargetOffset(VulkanOffset3D value)
Copy the current immutable object by setting a value for thetargetOffset
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for targetOffset- Returns:
- A modified copy of the
this
object
-
withExtent
public final VulkanImageCopy withExtent(VulkanExtent3D value)
Copy the current immutable object by setting a value for theextent
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for extent- Returns:
- A modified copy of the
this
object
-
equals
public boolean equals(java.lang.Object another)
This instance is equal to all instances ofVulkanImageCopy
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:sourceSubresource
,sourceOffset
,targetSubresource
,targetOffset
,extent
.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- hashCode value
-
toString
public java.lang.String toString()
Prints the immutable valueVulkanImageCopy
with attribute values.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of the value
-
of
public static VulkanImageCopy of(VulkanImageSubresourceLayers sourceSubresource, VulkanOffset3D sourceOffset, VulkanImageSubresourceLayers targetSubresource, VulkanOffset3D targetOffset, VulkanExtent3D extent)
Construct a new immutableVulkanImageCopy
instance.- Parameters:
sourceSubresource
- The value for thesourceSubresource
attributesourceOffset
- The value for thesourceOffset
attributetargetSubresource
- The value for thetargetSubresource
attributetargetOffset
- The value for thetargetOffset
attributeextent
- The value for theextent
attribute- Returns:
- An immutable VulkanImageCopy instance
-
copyOf
public static VulkanImageCopy copyOf(VulkanImageCopyType instance)
Creates an immutable copy of aVulkanImageCopyType
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 VulkanImageCopy instance
-
builder
public static VulkanImageCopy.Builder builder()
Creates a builder forVulkanImageCopy
.- Returns:
- A new VulkanImageCopy builder
-
-