Package org.lwjgl.vulkan

Class VkAttachmentDescription2KHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct

org.lwjgl.vulkan.VkAttachmentDescription2

org.lwjgl.vulkan.VkAttachmentDescription2KHR

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkAttachmentDescription2KHR
extends VkAttachmentDescription2

See VkAttachmentDescription2.

Layout

 struct VkAttachmentDescription2KHR {
     VkStructureType sType;
     void const * pNext;
     VkAttachmentDescriptionFlags flags;
     VkFormat format;
     VkSampleCountFlagBits samples;
     VkAttachmentLoadOp loadOp;
     VkAttachmentStoreOp storeOp;
     VkAttachmentLoadOp stencilLoadOp;
     VkAttachmentStoreOp stencilStoreOp;
     VkImageLayout initialLayout;
     VkImageLayout finalLayout;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkAttachmentDescription2KHR.Buffer	An array of VkAttachmentDescription2KHR structs.

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Fields inherited from class org.lwjgl.vulkan.VkAttachmentDescription2

ALIGNOF, FINALLAYOUT, FLAGS, FORMAT, INITIALLAYOUT, LOADOP, PNEXT, SAMPLES, SIZEOF, STENCILLOADOP, STENCILSTOREOP, STOREOP, STYPE

Constructor Summary

Constructors

Constructor	Description
VkAttachmentDescription2KHR(java.nio.ByteBuffer container)	Creates a VkAttachmentDescription2KHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkAttachmentDescription2KHR	calloc()	Returns a new VkAttachmentDescription2KHR instance allocated with memCalloc.
static VkAttachmentDescription2KHR.Buffer	calloc(int capacity)	Returns a new VkAttachmentDescription2KHR.Buffer instance allocated with memCalloc.
static VkAttachmentDescription2KHR.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentDescription2KHR	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentDescription2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkAttachmentDescription2KHR	callocStack()	Deprecated.
static VkAttachmentDescription2KHR.Buffer	callocStack(int capacity)	Deprecated.
static VkAttachmentDescription2KHR.Buffer	callocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAttachmentDescription2KHR	callocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAttachmentDescription2KHR	create()	Returns a new VkAttachmentDescription2KHR instance allocated with BufferUtils.
static VkAttachmentDescription2KHR.Buffer	create(int capacity)	Returns a new VkAttachmentDescription2KHR.Buffer instance allocated with BufferUtils.
static VkAttachmentDescription2KHR	create(long address)	Returns a new VkAttachmentDescription2KHR instance for the specified memory address.
static VkAttachmentDescription2KHR.Buffer	create(long address, int capacity)	Create a VkAttachmentDescription2KHR.Buffer instance at the specified memory.
static VkAttachmentDescription2KHR	createSafe(long address)	Like create, but returns null if address is NULL.
static VkAttachmentDescription2KHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
VkAttachmentDescription2KHR	finalLayout(int value)	Sets the specified value to the finalLayout field.
VkAttachmentDescription2KHR	flags(int value)	Sets the specified value to the flags field.
VkAttachmentDescription2KHR	format(int value)	Sets the specified value to the format field.
VkAttachmentDescription2KHR	initialLayout(int value)	Sets the specified value to the initialLayout field.
VkAttachmentDescription2KHR	loadOp(int value)	Sets the specified value to the loadOp field.
static VkAttachmentDescription2KHR	malloc()	Returns a new VkAttachmentDescription2KHR instance allocated with memAlloc.
static VkAttachmentDescription2KHR.Buffer	malloc(int capacity)	Returns a new VkAttachmentDescription2KHR.Buffer instance allocated with memAlloc.
static VkAttachmentDescription2KHR.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack.
static VkAttachmentDescription2KHR	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkAttachmentDescription2KHR instance allocated on the specified MemoryStack.
static VkAttachmentDescription2KHR	mallocStack()	Deprecated.
static VkAttachmentDescription2KHR.Buffer	mallocStack(int capacity)	Deprecated.
static VkAttachmentDescription2KHR.Buffer	mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)	Deprecated.
static VkAttachmentDescription2KHR	mallocStack(org.lwjgl.system.MemoryStack stack)	Deprecated.
VkAttachmentDescription2KHR	pNext(long value)	Sets the specified value to the pNext field.
VkAttachmentDescription2KHR	samples(int value)	Sets the specified value to the samples field.
VkAttachmentDescription2KHR	set(int sType, long pNext, int flags, int format, int samples, int loadOp, int storeOp, int stencilLoadOp, int stencilStoreOp, int initialLayout, int finalLayout)	Initializes this struct with the specified values.
VkAttachmentDescription2KHR	set(VkAttachmentDescription2KHR src)	Copies the specified struct data to this struct.
VkAttachmentDescription2KHR	stencilLoadOp(int value)	Sets the specified value to the stencilLoadOp field.
VkAttachmentDescription2KHR	stencilStoreOp(int value)	Sets the specified value to the stencilStoreOp field.
VkAttachmentDescription2KHR	storeOp(int value)	Sets the specified value to the storeOp field.
VkAttachmentDescription2KHR	sType(int value)	Sets the specified value to the sType field.
VkAttachmentDescription2KHR	sType$Default()	Sets the STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2 value to the sType field.

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate

Methods inherited from class org.lwjgl.vulkan.VkAttachmentDescription2

finalLayout, flags, format, initialLayout, loadOp, nfinalLayout, nfinalLayout, nflags, nflags, nformat, nformat, ninitialLayout, ninitialLayout, nloadOp, nloadOp, npNext, npNext, nsamples, nsamples, nstencilLoadOp, nstencilLoadOp, nstencilStoreOp, nstencilStoreOp, nstoreOp, nstoreOp, nsType, nsType, pNext, pNext, pNext, samples, set, sizeof, stencilLoadOp, stencilStoreOp, storeOp, sType

Constructor Detail

VkAttachmentDescription2KHR

public VkAttachmentDescription2KHR(java.nio.ByteBuffer container)

Creates a VkAttachmentDescription2KHR instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

sType

public VkAttachmentDescription2KHR sType(int value)

Sets the specified value to the sType field.

Overrides:

sType in class VkAttachmentDescription2

sType$Default

public VkAttachmentDescription2KHR sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2 value to the sType field.

Overrides:

sType$Default in class VkAttachmentDescription2

pNext

public VkAttachmentDescription2KHR pNext(long value)

Sets the specified value to the pNext field.

Overrides:

pNext in class VkAttachmentDescription2

flags

public VkAttachmentDescription2KHR flags(int value)

Sets the specified value to the flags field.

Overrides:

flags in class VkAttachmentDescription2

format

public VkAttachmentDescription2KHR format(int value)

Sets the specified value to the format field.

Overrides:

format in class VkAttachmentDescription2

samples

public VkAttachmentDescription2KHR samples(int value)

Sets the specified value to the samples field.

Overrides:

samples in class VkAttachmentDescription2

loadOp

public VkAttachmentDescription2KHR loadOp(int value)

Sets the specified value to the loadOp field.

Overrides:

loadOp in class VkAttachmentDescription2

storeOp

public VkAttachmentDescription2KHR storeOp(int value)

Sets the specified value to the storeOp field.

Overrides:

storeOp in class VkAttachmentDescription2

stencilLoadOp

public VkAttachmentDescription2KHR stencilLoadOp(int value)

Sets the specified value to the stencilLoadOp field.

Overrides:

stencilLoadOp in class VkAttachmentDescription2

stencilStoreOp

public VkAttachmentDescription2KHR stencilStoreOp(int value)

Sets the specified value to the stencilStoreOp field.

Overrides:

stencilStoreOp in class VkAttachmentDescription2

initialLayout

public VkAttachmentDescription2KHR initialLayout(int value)

Sets the specified value to the initialLayout field.

Overrides:

initialLayout in class VkAttachmentDescription2

finalLayout

public VkAttachmentDescription2KHR finalLayout(int value)

Sets the specified value to the finalLayout field.

Overrides:

finalLayout in class VkAttachmentDescription2

set

public VkAttachmentDescription2KHR set(int sType,
                                       long pNext,
                                       int flags,
                                       int format,
                                       int samples,
                                       int loadOp,
                                       int storeOp,
                                       int stencilLoadOp,
                                       int stencilStoreOp,
                                       int initialLayout,
                                       int finalLayout)

Initializes this struct with the specified values.

Overrides:

set in class VkAttachmentDescription2

set

public VkAttachmentDescription2KHR set(VkAttachmentDescription2KHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkAttachmentDescription2KHR malloc()

Returns a new VkAttachmentDescription2KHR instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static VkAttachmentDescription2KHR calloc()

Returns a new VkAttachmentDescription2KHR instance allocated with memCalloc. The instance must be explicitly freed.

create

public static VkAttachmentDescription2KHR create()

Returns a new VkAttachmentDescription2KHR instance allocated with BufferUtils.

create

public static VkAttachmentDescription2KHR create(long address)

Returns a new VkAttachmentDescription2KHR instance for the specified memory address.

createSafe

@Nullable
public static VkAttachmentDescription2KHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkAttachmentDescription2KHR.Buffer malloc(int capacity)

Returns a new VkAttachmentDescription2KHR.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static VkAttachmentDescription2KHR.Buffer calloc(int capacity)

Returns a new VkAttachmentDescription2KHR.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static VkAttachmentDescription2KHR.Buffer create(int capacity)

Returns a new VkAttachmentDescription2KHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkAttachmentDescription2KHR.Buffer create(long address,
                                                        int capacity)

Create a VkAttachmentDescription2KHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

@Nullable
public static VkAttachmentDescription2KHR.Buffer createSafe(long address,
                                                            int capacity)

Like create, but returns null if address is NULL.

mallocStack

@Deprecated
public static VkAttachmentDescription2KHR mallocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkAttachmentDescription2KHR callocStack()

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkAttachmentDescription2KHR mallocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

callocStack

@Deprecated
public static VkAttachmentDescription2KHR callocStack(org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

mallocStack

@Deprecated
public static VkAttachmentDescription2KHR.Buffer mallocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkAttachmentDescription2KHR.Buffer callocStack(int capacity)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

mallocStack

@Deprecated
public static VkAttachmentDescription2KHR.Buffer mallocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

callocStack

@Deprecated
public static VkAttachmentDescription2KHR.Buffer callocStack(int capacity,
                                                             org.lwjgl.system.MemoryStack stack)

Deprecated.

Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

malloc

public static VkAttachmentDescription2KHR malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentDescription2KHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkAttachmentDescription2KHR calloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentDescription2KHR instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static VkAttachmentDescription2KHR.Buffer malloc(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

calloc

public static VkAttachmentDescription2KHR.Buffer calloc(int capacity,
                                                        org.lwjgl.system.MemoryStack stack)

Returns a new VkAttachmentDescription2KHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity