Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanImageMemoryBarrier

java.lang.Object

com.io7m.jcoronado.api.VulkanImageMemoryBarrier

All Implemented Interfaces:

VulkanImageMemoryBarrierType

public final class VulkanImageMemoryBarrier
extends java.lang.Object
implements VulkanImageMemoryBarrierType

Structure specifying the parameters of an image memory barrier.

See Also:

"VkImageMemoryBarrier"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VulkanImageMemoryBarrier.Builder	builder()	Creates a builder for VulkanImageMemoryBarrier.
static VulkanImageMemoryBarrier	copyOf(VulkanImageMemoryBarrierType instance)	Creates an immutable copy of a VulkanImageMemoryBarrierType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanImageMemoryBarrier that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: sourceAccessMask, targetAccessMask, oldLayout, newLayout, sourceQueueFamilyIndex, targetQueueFamilyIndex, image, subresourceRange.
VulkanImageType	image()
VulkanImageLayout	newLayout()
static VulkanImageMemoryBarrier	of(java.lang.Iterable<VulkanAccessFlag> sourceAccessMask, java.lang.Iterable<VulkanAccessFlag> targetAccessMask, VulkanImageLayout oldLayout, VulkanImageLayout newLayout, int sourceQueueFamilyIndex, int targetQueueFamilyIndex, VulkanImageType image, VulkanImageSubresourceRange subresourceRange)	Construct a new immutable VulkanImageMemoryBarrier instance.
static VulkanImageMemoryBarrier	of(java.util.Set<VulkanAccessFlag> sourceAccessMask, java.util.Set<VulkanAccessFlag> targetAccessMask, VulkanImageLayout oldLayout, VulkanImageLayout newLayout, int sourceQueueFamilyIndex, int targetQueueFamilyIndex, VulkanImageType image, VulkanImageSubresourceRange subresourceRange)	Construct a new immutable VulkanImageMemoryBarrier instance.
VulkanImageLayout	oldLayout()
java.util.Set<VulkanAccessFlag>	sourceAccessMask()
int	sourceQueueFamilyIndex()
VulkanImageSubresourceRange	subresourceRange()
java.util.Set<VulkanAccessFlag>	targetAccessMask()
int	targetQueueFamilyIndex()
java.lang.String	toString()	Prints the immutable value VulkanImageMemoryBarrier with attribute values.
VulkanImageMemoryBarrier	withImage(VulkanImageType value)	Copy the current immutable object by setting a value for the image attribute.
VulkanImageMemoryBarrier	withNewLayout(VulkanImageLayout value)	Copy the current immutable object by setting a value for the newLayout attribute.
VulkanImageMemoryBarrier	withOldLayout(VulkanImageLayout value)	Copy the current immutable object by setting a value for the oldLayout attribute.
VulkanImageMemoryBarrier	withSourceAccessMask(VulkanAccessFlag... elements)	Copy the current immutable object with elements that replace the content of sourceAccessMask.
VulkanImageMemoryBarrier	withSourceAccessMask(java.lang.Iterable<VulkanAccessFlag> elements)	Copy the current immutable object with elements that replace the content of sourceAccessMask.
VulkanImageMemoryBarrier	withSourceQueueFamilyIndex(int value)	Copy the current immutable object by setting a value for the sourceQueueFamilyIndex attribute.
VulkanImageMemoryBarrier	withSubresourceRange(VulkanImageSubresourceRange value)	Copy the current immutable object by setting a value for the subresourceRange attribute.
VulkanImageMemoryBarrier	withTargetAccessMask(VulkanAccessFlag... elements)	Copy the current immutable object with elements that replace the content of targetAccessMask.
VulkanImageMemoryBarrier	withTargetAccessMask(java.lang.Iterable<VulkanAccessFlag> elements)	Copy the current immutable object with elements that replace the content of targetAccessMask.
VulkanImageMemoryBarrier	withTargetQueueFamilyIndex(int value)	Copy the current immutable object by setting a value for the targetQueueFamilyIndex attribute.

Methods inherited from class java.lang.Object

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

Method Detail

sourceAccessMask

public java.util.Set<VulkanAccessFlag> sourceAccessMask()

Specified by:

sourceAccessMask in interface VulkanImageMemoryBarrierType

Returns:

The source access mask

targetAccessMask

public java.util.Set<VulkanAccessFlag> targetAccessMask()

Specified by:

targetAccessMask in interface VulkanImageMemoryBarrierType

Returns:

The target access mask

oldLayout

public VulkanImageLayout oldLayout()

Specified by:

oldLayout in interface VulkanImageMemoryBarrierType

Returns:

The original image layout

newLayout

public VulkanImageLayout newLayout()

Specified by:

newLayout in interface VulkanImageMemoryBarrierType

Returns:

The target image layout

sourceQueueFamilyIndex

public int sourceQueueFamilyIndex()

Specified by:

sourceQueueFamilyIndex in interface VulkanImageMemoryBarrierType

Returns:

The source queue family for a queue family ownership transfer.

targetQueueFamilyIndex

public int targetQueueFamilyIndex()

Specified by:

targetQueueFamilyIndex in interface VulkanImageMemoryBarrierType

Returns:

The target queue family for a queue family ownership transfer.

image

public VulkanImageType image()

Specified by:

image in interface VulkanImageMemoryBarrierType

Returns:

The image affected by this barrier.

subresourceRange

public VulkanImageSubresourceRange subresourceRange()

Specified by:

subresourceRange in interface VulkanImageMemoryBarrierType

Returns:

The image subresource range within image that is affected by this barrier.

withSourceAccessMask

public final VulkanImageMemoryBarrier withSourceAccessMask(VulkanAccessFlag... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSourceAccessMask

public final VulkanImageMemoryBarrier withSourceAccessMask(java.lang.Iterable<VulkanAccessFlag> elements)

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

Parameters:

elements - An iterable of sourceAccessMask elements to set

Returns:

A modified copy of this object

withTargetAccessMask

public final VulkanImageMemoryBarrier withTargetAccessMask(VulkanAccessFlag... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withTargetAccessMask

public final VulkanImageMemoryBarrier withTargetAccessMask(java.lang.Iterable<VulkanAccessFlag> elements)

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

Parameters:

elements - An iterable of targetAccessMask elements to set

Returns:

A modified copy of this object

withOldLayout

public final VulkanImageMemoryBarrier withOldLayout(VulkanImageLayout value)

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

Parameters:

value - A new value for oldLayout

Returns:

A modified copy of the this object

withNewLayout

public final VulkanImageMemoryBarrier withNewLayout(VulkanImageLayout value)

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

Parameters:

value - A new value for newLayout

Returns:

A modified copy of the this object

withSourceQueueFamilyIndex

public final VulkanImageMemoryBarrier withSourceQueueFamilyIndex(int value)

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

Parameters:

value - A new value for sourceQueueFamilyIndex

Returns:

A modified copy of the this object

withTargetQueueFamilyIndex

public final VulkanImageMemoryBarrier withTargetQueueFamilyIndex(int value)

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

Parameters:

value - A new value for targetQueueFamilyIndex

Returns:

A modified copy of the this object

withImage

public final VulkanImageMemoryBarrier withImage(VulkanImageType value)

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

Parameters:

value - A new value for image

Returns:

A modified copy of the this object

withSubresourceRange

public final VulkanImageMemoryBarrier withSubresourceRange(VulkanImageSubresourceRange value)

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

Parameters:

value - A new value for subresourceRange

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanImageMemoryBarrier 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: sourceAccessMask, targetAccessMask, oldLayout, newLayout, sourceQueueFamilyIndex, targetQueueFamilyIndex, image, subresourceRange.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanImageMemoryBarrier with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanImageMemoryBarrier of(java.util.Set<VulkanAccessFlag> sourceAccessMask,
                                          java.util.Set<VulkanAccessFlag> targetAccessMask,
                                          VulkanImageLayout oldLayout,
                                          VulkanImageLayout newLayout,
                                          int sourceQueueFamilyIndex,
                                          int targetQueueFamilyIndex,
                                          VulkanImageType image,
                                          VulkanImageSubresourceRange subresourceRange)

Construct a new immutable VulkanImageMemoryBarrier instance.

Parameters:

sourceAccessMask - The value for the sourceAccessMask attribute

targetAccessMask - The value for the targetAccessMask attribute

oldLayout - The value for the oldLayout attribute

newLayout - The value for the newLayout attribute

sourceQueueFamilyIndex - The value for the sourceQueueFamilyIndex attribute

targetQueueFamilyIndex - The value for the targetQueueFamilyIndex attribute

image - The value for the image attribute

subresourceRange - The value for the subresourceRange attribute

Returns:

An immutable VulkanImageMemoryBarrier instance

of

public static VulkanImageMemoryBarrier of(java.lang.Iterable<VulkanAccessFlag> sourceAccessMask,
                                          java.lang.Iterable<VulkanAccessFlag> targetAccessMask,
                                          VulkanImageLayout oldLayout,
                                          VulkanImageLayout newLayout,
                                          int sourceQueueFamilyIndex,
                                          int targetQueueFamilyIndex,
                                          VulkanImageType image,
                                          VulkanImageSubresourceRange subresourceRange)

Construct a new immutable VulkanImageMemoryBarrier instance.

Parameters:

sourceAccessMask - The value for the sourceAccessMask attribute

targetAccessMask - The value for the targetAccessMask attribute

oldLayout - The value for the oldLayout attribute

newLayout - The value for the newLayout attribute

sourceQueueFamilyIndex - The value for the sourceQueueFamilyIndex attribute

targetQueueFamilyIndex - The value for the targetQueueFamilyIndex attribute

image - The value for the image attribute

subresourceRange - The value for the subresourceRange attribute

Returns:

An immutable VulkanImageMemoryBarrier instance

copyOf

public static VulkanImageMemoryBarrier copyOf(VulkanImageMemoryBarrierType instance)

Creates an immutable copy of a VulkanImageMemoryBarrierType 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 VulkanImageMemoryBarrier instance

builder

public static VulkanImageMemoryBarrier.Builder builder()

Creates a builder for VulkanImageMemoryBarrier.

Returns:

A new VulkanImageMemoryBarrier builder