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

Package com.io7m.jcoronado.extensions.khr_surface.api

Class VulkanSurfaceFormatKHR

java.lang.Object

com.io7m.jcoronado.extensions.khr_surface.api.VulkanSurfaceFormatKHR

All Implemented Interfaces:

VulkanSurfaceFormatKHRType

public final class VulkanSurfaceFormatKHR
extends java.lang.Object
implements VulkanSurfaceFormatKHRType

See Also:

"VkSurfaceFormatKHR"

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VulkanSurfaceFormatKHR.Builder	builder()	Creates a builder for VulkanSurfaceFormatKHR.
VulkanColorSpaceKHR	colorSpace()
static VulkanSurfaceFormatKHR	copyOf(VulkanSurfaceFormatKHRType instance)	Creates an immutable copy of a VulkanSurfaceFormatKHRType value.
boolean	equals(java.lang.Object another)	This instance is equal to all instances of VulkanSurfaceFormatKHR that have equal attribute values.
VulkanFormat	format()
int	hashCode()	Computes a hash code from attributes: format, colorSpace.
static VulkanSurfaceFormatKHR	of(VulkanFormat format, VulkanColorSpaceKHR colorSpace)	Construct a new immutable VulkanSurfaceFormatKHR instance.
java.lang.String	toString()	Prints the immutable value VulkanSurfaceFormatKHR with attribute values.
VulkanSurfaceFormatKHR	withColorSpace(VulkanColorSpaceKHR value)	Copy the current immutable object by setting a value for the colorSpace attribute.
VulkanSurfaceFormatKHR	withFormat(VulkanFormat value)	Copy the current immutable object by setting a value for the format attribute.

Methods inherited from class java.lang.Object

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

Method Detail

format

public VulkanFormat format()

Specified by:

format in interface VulkanSurfaceFormatKHRType

Returns:

A format that is compatible with the specified surface.

colorSpace

public VulkanColorSpaceKHR colorSpace()

Specified by:

colorSpace in interface VulkanSurfaceFormatKHRType

Returns:

A presentation color space that is compatible with the surface.

withFormat

public final VulkanSurfaceFormatKHR withFormat(VulkanFormat value)

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

Parameters:

value - A new value for format

Returns:

A modified copy of the this object

withColorSpace

public final VulkanSurfaceFormatKHR withColorSpace(VulkanColorSpaceKHR value)

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

Parameters:

value - A new value for colorSpace

Returns:

A modified copy of the this object

equals

public boolean equals(java.lang.Object another)

This instance is equal to all instances of VulkanSurfaceFormatKHR 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: format, colorSpace.

Overrides:

hashCode in class java.lang.Object

Returns:

hashCode value

toString

public java.lang.String toString()

Prints the immutable value VulkanSurfaceFormatKHR with attribute values.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the value

of

public static VulkanSurfaceFormatKHR of(VulkanFormat format,
                                        VulkanColorSpaceKHR colorSpace)

Construct a new immutable VulkanSurfaceFormatKHR instance.

Parameters:

format - The value for the format attribute

colorSpace - The value for the colorSpace attribute

Returns:

An immutable VulkanSurfaceFormatKHR instance

copyOf

public static VulkanSurfaceFormatKHR copyOf(VulkanSurfaceFormatKHRType instance)

Creates an immutable copy of a VulkanSurfaceFormatKHRType 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 VulkanSurfaceFormatKHR instance

builder

public static VulkanSurfaceFormatKHR.Builder builder()

Creates a builder for VulkanSurfaceFormatKHR.

Returns:

A new VulkanSurfaceFormatKHR builder