Module com.io7m.jcoronado.extensions.khr.surface.api

Package com.io7m.jcoronado.extensions.khr_swapchain.api

Class VulkanPresentInfoKHR

java.lang.Object

com.io7m.jcoronado.extensions.khr_swapchain.api.VulkanPresentInfoKHR

All Implemented Interfaces:

VulkanPresentInfoKHRType

public final class VulkanPresentInfoKHR
extends java.lang.Object
implements VulkanPresentInfoKHRType

See Also:

"VkPresentInfoKHR"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VulkanPresentInfoKHR.Builder	builder()	Creates a builder for VulkanPresentInfoKHR.
static VulkanPresentInfoKHR	copyOf(VulkanPresentInfoKHRType instance)	Creates an immutable copy of a VulkanPresentInfoKHRType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanPresentInfoKHR that have equal attribute values.
int	hashCode()	Computes a hash code from attributes: waitSemaphores, swapChains, imageIndices.
java.util.List<java.lang.Integer>	imageIndices()	Each entry in this array identifies the image to present on the corresponding entry in the swapChains() list.
static VulkanPresentInfoKHR	of(java.lang.Iterable<? extends VulkanSemaphoreType> waitSemaphores, java.lang.Iterable<? extends VulkanExtKHRSwapChainType.VulkanKHRSwapChainType> swapChains, java.lang.Iterable<java.lang.Integer> imageIndices)	Construct a new immutable VulkanPresentInfoKHR instance.
static VulkanPresentInfoKHR	of(java.util.List<VulkanSemaphoreType> waitSemaphores, java.util.List<VulkanExtKHRSwapChainType.VulkanKHRSwapChainType> swapChains, java.util.List<java.lang.Integer> imageIndices)	Construct a new immutable VulkanPresentInfoKHR instance.
java.util.List<VulkanExtKHRSwapChainType.VulkanKHRSwapChainType>	swapChains()
java.lang.String	toString()	Prints the immutable value VulkanPresentInfoKHR with attribute values.
java.util.List<VulkanSemaphoreType>	waitSemaphores()
VulkanPresentInfoKHR	withImageIndices(int... elements)	Copy the current immutable object with elements that replace the content of imageIndices.
VulkanPresentInfoKHR	withImageIndices(java.lang.Iterable<java.lang.Integer> elements)	Copy the current immutable object with elements that replace the content of imageIndices.
VulkanPresentInfoKHR	withSwapChains(VulkanExtKHRSwapChainType.VulkanKHRSwapChainType... elements)	Copy the current immutable object with elements that replace the content of swapChains.
VulkanPresentInfoKHR	withSwapChains(java.lang.Iterable<? extends VulkanExtKHRSwapChainType.VulkanKHRSwapChainType> elements)	Copy the current immutable object with elements that replace the content of swapChains.
VulkanPresentInfoKHR	withWaitSemaphores(VulkanSemaphoreType... elements)	Copy the current immutable object with elements that replace the content of waitSemaphores.
VulkanPresentInfoKHR	withWaitSemaphores(java.lang.Iterable<? extends VulkanSemaphoreType> elements)	Copy the current immutable object with elements that replace the content of waitSemaphores.

Methods inherited from class java.lang.Object

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

Method Detail

waitSemaphores

public java.util.List<VulkanSemaphoreType> waitSemaphores()

Specified by:

waitSemaphores in interface VulkanPresentInfoKHRType

Returns:

The semaphores upon which to wait before issuing the present request.

swapChains

public java.util.List<VulkanExtKHRSwapChainType.VulkanKHRSwapChainType> swapChains()

Specified by:

swapChains in interface VulkanPresentInfoKHRType

Returns:

The list of swapchains

imageIndices

public java.util.List<java.lang.Integer> imageIndices()

Each entry in this array identifies the image to present on the corresponding entry in the swapChains() list.

Specified by:

imageIndices in interface VulkanPresentInfoKHRType

Returns:

An array of images to be presented

withWaitSemaphores

public final VulkanPresentInfoKHR withWaitSemaphores(VulkanSemaphoreType... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withWaitSemaphores

public final VulkanPresentInfoKHR withWaitSemaphores(java.lang.Iterable<? extends VulkanSemaphoreType> elements)

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

Parameters:

elements - An iterable of waitSemaphores elements to set

Returns:

A modified copy of this object

withSwapChains

public final VulkanPresentInfoKHR withSwapChains(VulkanExtKHRSwapChainType.VulkanKHRSwapChainType... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSwapChains

public final VulkanPresentInfoKHR withSwapChains(java.lang.Iterable<? extends VulkanExtKHRSwapChainType.VulkanKHRSwapChainType> elements)

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

Parameters:

elements - An iterable of swapChains elements to set

Returns:

A modified copy of this object

withImageIndices

public final VulkanPresentInfoKHR withImageIndices(int... elements)

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

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withImageIndices

public final VulkanPresentInfoKHR withImageIndices(java.lang.Iterable<java.lang.Integer> elements)

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

Parameters:

elements - An iterable of imageIndices elements to set

Returns:

A modified copy of this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanPresentInfoKHR 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: waitSemaphores, swapChains, imageIndices.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanPresentInfoKHR with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanPresentInfoKHR of(java.util.List<VulkanSemaphoreType> waitSemaphores,
                                      java.util.List<VulkanExtKHRSwapChainType.VulkanKHRSwapChainType> swapChains,
                                      java.util.List<java.lang.Integer> imageIndices)

Construct a new immutable VulkanPresentInfoKHR instance.

Parameters:

waitSemaphores - The value for the waitSemaphores attribute

swapChains - The value for the swapChains attribute

imageIndices - The value for the imageIndices attribute

Returns:

An immutable VulkanPresentInfoKHR instance

of

public static VulkanPresentInfoKHR of(java.lang.Iterable<? extends VulkanSemaphoreType> waitSemaphores,
                                      java.lang.Iterable<? extends VulkanExtKHRSwapChainType.VulkanKHRSwapChainType> swapChains,
                                      java.lang.Iterable<java.lang.Integer> imageIndices)

Construct a new immutable VulkanPresentInfoKHR instance.

Parameters:

waitSemaphores - The value for the waitSemaphores attribute

swapChains - The value for the swapChains attribute

imageIndices - The value for the imageIndices attribute

Returns:

An immutable VulkanPresentInfoKHR instance

copyOf

public static VulkanPresentInfoKHR copyOf(VulkanPresentInfoKHRType instance)

Creates an immutable copy of a VulkanPresentInfoKHRType 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 VulkanPresentInfoKHR instance

builder

public static VulkanPresentInfoKHR.Builder builder()

Creates a builder for VulkanPresentInfoKHR.

Returns:

A new VulkanPresentInfoKHR builder