Module com.io7m.jcoronado.api

Package com.io7m.jcoronado.api

Class VulkanBufferImageCopy.Builder

java.lang.Object

com.io7m.jcoronado.api.VulkanBufferImageCopy.Builder

Enclosing class:

VulkanBufferImageCopy

public static final class VulkanBufferImageCopy.Builder
extends java.lang.Object

Builds instances of type VulkanBufferImageCopy. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
VulkanBufferImageCopy	build()	Builds a new VulkanBufferImageCopy.
VulkanBufferImageCopy.Builder	from(VulkanBufferImageCopyType instance)	Fill a builder with attribute values from the provided VulkanBufferImageCopyType instance.
VulkanBufferImageCopy.Builder	setBufferImageHeight(int bufferImageHeight)	Initializes the value for the bufferImageHeight attribute.
VulkanBufferImageCopy.Builder	setBufferOffset(long bufferOffset)	Initializes the value for the bufferOffset attribute.
VulkanBufferImageCopy.Builder	setBufferRowLength(int bufferRowLength)	Initializes the value for the bufferRowLength attribute.
VulkanBufferImageCopy.Builder	setImageExtent(VulkanExtent3D imageExtent)	Initializes the value for the imageExtent attribute.
VulkanBufferImageCopy.Builder	setImageOffset(VulkanOffset3D imageOffset)	Initializes the value for the imageOffset attribute.
VulkanBufferImageCopy.Builder	setImageSubresource(VulkanImageSubresourceLayers imageSubresource)	Initializes the value for the imageSubresource attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public final VulkanBufferImageCopy.Builder from(VulkanBufferImageCopyType instance)

Fill a builder with attribute values from the provided VulkanBufferImageCopyType instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

setBufferOffset

public final VulkanBufferImageCopy.Builder setBufferOffset(long bufferOffset)

Initializes the value for the bufferOffset attribute.

Parameters:

bufferOffset - The value for bufferOffset

Returns:

this builder for use in a chained invocation

setBufferRowLength

public final VulkanBufferImageCopy.Builder setBufferRowLength(int bufferRowLength)

Initializes the value for the bufferRowLength attribute.

Parameters:

bufferRowLength - The value for bufferRowLength

Returns:

this builder for use in a chained invocation

setBufferImageHeight

public final VulkanBufferImageCopy.Builder setBufferImageHeight(int bufferImageHeight)

Initializes the value for the bufferImageHeight attribute.

Parameters:

bufferImageHeight - The value for bufferImageHeight

Returns:

this builder for use in a chained invocation

setImageSubresource

public final VulkanBufferImageCopy.Builder setImageSubresource(VulkanImageSubresourceLayers imageSubresource)

Initializes the value for the imageSubresource attribute.

Parameters:

imageSubresource - The value for imageSubresource

Returns:

this builder for use in a chained invocation

setImageOffset

public final VulkanBufferImageCopy.Builder setImageOffset(VulkanOffset3D imageOffset)

Initializes the value for the imageOffset attribute.

Parameters:

imageOffset - The value for imageOffset

Returns:

this builder for use in a chained invocation

setImageExtent

public final VulkanBufferImageCopy.Builder setImageExtent(VulkanExtent3D imageExtent)

Initializes the value for the imageExtent attribute.

Parameters:

imageExtent - The value for imageExtent

Returns:

this builder for use in a chained invocation

build

public VulkanBufferImageCopy build()

Builds a new VulkanBufferImageCopy.

Returns:

An immutable instance of VulkanBufferImageCopy

Throws:

java.lang.IllegalStateException - if any required attributes are missing