Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanBufferMemoryBarrier

java.lang.Object

com.io7m.jcoronado.api.VulkanBufferMemoryBarrier

All Implemented Interfaces:

VulkanBufferMemoryBarrierType

public final class VulkanBufferMemoryBarrier
extends java.lang.Object
implements VulkanBufferMemoryBarrierType

Structure specifying the parameters of a buffer memory barrier.

See Also:

"VkBufferMemoryBarrier"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
VulkanBufferType	buffer()
static VulkanBufferMemoryBarrier.Builder	builder()	Creates a builder for VulkanBufferMemoryBarrier.
static VulkanBufferMemoryBarrier	copyOf(VulkanBufferMemoryBarrierType instance)	Creates an immutable copy of a VulkanBufferMemoryBarrierType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanBufferMemoryBarrier that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: sourceAccessMask, targetAccessMask, sourceQueueFamilyIndex, targetQueueFamilyIndex, buffer, offset, size.
static VulkanBufferMemoryBarrier	of(java.lang.Iterable<VulkanAccessFlag> sourceAccessMask, java.lang.Iterable<VulkanAccessFlag> targetAccessMask, int sourceQueueFamilyIndex, int targetQueueFamilyIndex, VulkanBufferType buffer, long offset, long size)	Construct a new immutable VulkanBufferMemoryBarrier instance.
static VulkanBufferMemoryBarrier	of(java.util.Set<VulkanAccessFlag> sourceAccessMask, java.util.Set<VulkanAccessFlag> targetAccessMask, int sourceQueueFamilyIndex, int targetQueueFamilyIndex, VulkanBufferType buffer, long offset, long size)	Construct a new immutable VulkanBufferMemoryBarrier instance.
long	offset()
long	size()
java.util.Set<VulkanAccessFlag>	sourceAccessMask()
int	sourceQueueFamilyIndex()
java.util.Set<VulkanAccessFlag>	targetAccessMask()
int	targetQueueFamilyIndex()
java.lang.String	toString()	Prints the immutable value VulkanBufferMemoryBarrier with attribute values.
VulkanBufferMemoryBarrier	withBuffer(VulkanBufferType value)	Copy the current immutable object by setting a value for the buffer attribute.
VulkanBufferMemoryBarrier	withOffset(long value)	Copy the current immutable object by setting a value for the offset attribute.
VulkanBufferMemoryBarrier	withSize(long value)	Copy the current immutable object by setting a value for the size attribute.
VulkanBufferMemoryBarrier	withSourceAccessMask(VulkanAccessFlag... elements)	Copy the current immutable object with elements that replace the content of sourceAccessMask.
VulkanBufferMemoryBarrier	withSourceAccessMask(java.lang.Iterable<VulkanAccessFlag> elements)	Copy the current immutable object with elements that replace the content of sourceAccessMask.
VulkanBufferMemoryBarrier	withSourceQueueFamilyIndex(int value)	Copy the current immutable object by setting a value for the sourceQueueFamilyIndex attribute.
VulkanBufferMemoryBarrier	withTargetAccessMask(VulkanAccessFlag... elements)	Copy the current immutable object with elements that replace the content of targetAccessMask.
VulkanBufferMemoryBarrier	withTargetAccessMask(java.lang.Iterable<VulkanAccessFlag> elements)	Copy the current immutable object with elements that replace the content of targetAccessMask.
VulkanBufferMemoryBarrier	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 VulkanBufferMemoryBarrierType

Returns:

The source access mask

targetAccessMask

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

Specified by:

targetAccessMask in interface VulkanBufferMemoryBarrierType

Returns:

The target access mask

sourceQueueFamilyIndex

public int sourceQueueFamilyIndex()

Specified by:

sourceQueueFamilyIndex in interface VulkanBufferMemoryBarrierType

Returns:

The source queue family for a queue family ownership transfer.

targetQueueFamilyIndex

public int targetQueueFamilyIndex()

Specified by:

targetQueueFamilyIndex in interface VulkanBufferMemoryBarrierType

Returns:

The target queue family for a queue family ownership transfer.

buffer

public VulkanBufferType buffer()

Specified by:

buffer in interface VulkanBufferMemoryBarrierType

Returns:

The buffer affected by this barrier.

offset

public long offset()

Specified by:

offset in interface VulkanBufferMemoryBarrierType

Returns:

An offset in bytes into the backing memory for buffer; this is relative to the base offset as bound to the buffer

size

public long size()

Specified by:

size in interface VulkanBufferMemoryBarrierType

Returns:

A size in bytes of the affected area of backing memory for buffer, or VK_WHOLE_SIZE to use the range from offset to the end of the buffer.

withSourceAccessMask

public final VulkanBufferMemoryBarrier 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 VulkanBufferMemoryBarrier 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 VulkanBufferMemoryBarrier 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 VulkanBufferMemoryBarrier 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

withSourceQueueFamilyIndex

public final VulkanBufferMemoryBarrier 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 VulkanBufferMemoryBarrier 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

withBuffer

public final VulkanBufferMemoryBarrier withBuffer(VulkanBufferType value)

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

Parameters:

value - A new value for buffer

Returns:

A modified copy of the this object

withOffset

public final VulkanBufferMemoryBarrier withOffset(long 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 VulkanBufferMemoryBarrier withSize(long 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 VulkanBufferMemoryBarrier 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, sourceQueueFamilyIndex, targetQueueFamilyIndex, buffer, offset, size.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanBufferMemoryBarrier with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanBufferMemoryBarrier of(java.util.Set<VulkanAccessFlag> sourceAccessMask,
                                           java.util.Set<VulkanAccessFlag> targetAccessMask,
                                           int sourceQueueFamilyIndex,
                                           int targetQueueFamilyIndex,
                                           VulkanBufferType buffer,
                                           long offset,
                                           long size)

Construct a new immutable VulkanBufferMemoryBarrier instance.

Parameters:

sourceAccessMask - The value for the sourceAccessMask attribute

targetAccessMask - The value for the targetAccessMask attribute

sourceQueueFamilyIndex - The value for the sourceQueueFamilyIndex attribute

targetQueueFamilyIndex - The value for the targetQueueFamilyIndex attribute

buffer - The value for the buffer attribute

offset - The value for the offset attribute

size - The value for the size attribute

Returns:

An immutable VulkanBufferMemoryBarrier instance

of

public static VulkanBufferMemoryBarrier of(java.lang.Iterable<VulkanAccessFlag> sourceAccessMask,
                                           java.lang.Iterable<VulkanAccessFlag> targetAccessMask,
                                           int sourceQueueFamilyIndex,
                                           int targetQueueFamilyIndex,
                                           VulkanBufferType buffer,
                                           long offset,
                                           long size)

Construct a new immutable VulkanBufferMemoryBarrier instance.

Parameters:

sourceAccessMask - The value for the sourceAccessMask attribute

targetAccessMask - The value for the targetAccessMask attribute

sourceQueueFamilyIndex - The value for the sourceQueueFamilyIndex attribute

targetQueueFamilyIndex - The value for the targetQueueFamilyIndex attribute

buffer - The value for the buffer attribute

offset - The value for the offset attribute

size - The value for the size attribute

Returns:

An immutable VulkanBufferMemoryBarrier instance

copyOf

public static VulkanBufferMemoryBarrier copyOf(VulkanBufferMemoryBarrierType instance)

Creates an immutable copy of a VulkanBufferMemoryBarrierType 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 VulkanBufferMemoryBarrier instance

builder

public static VulkanBufferMemoryBarrier.Builder builder()

Creates a builder for VulkanBufferMemoryBarrier.

Returns:

A new VulkanBufferMemoryBarrier builder