org.lwjgl.vulkan.VkAttachmentDescription2

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

Direct Known Subclasses:: VkAttachmentDescription2KHR

public class VkAttachmentDescription2 extends Struct<VkAttachmentDescription2> implements NativeResource

struct VkAttachmentDescription2 {
    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

VkAttachmentDescription2.Buffer

An array of VkAttachmentDescription2 structs.

Nested classes/interfaces inherited from class Struct
Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer
Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

FINALLAYOUT

The struct member offsets.

static final int

FLAGS

The struct member offsets.

static final int

FORMAT

The struct member offsets.

static final int

INITIALLAYOUT

The struct member offsets.

static final int

LOADOP

The struct member offsets.

static final int

PNEXT

The struct member offsets.

static final int

SAMPLES

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

STENCILLOADOP

The struct member offsets.

static final int

STENCILSTOREOP

The struct member offsets.

static final int

STOREOP

The struct member offsets.

static final int

STYPE

The struct member offsets.

Fields inherited from interface Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VkAttachmentDescription2(ByteBuffer container)

Creates a VkAttachmentDescription2 instance at the current position of the specified ByteBuffer container.
Method Summary

Modifier and Type

Method

Description

static VkAttachmentDescription2

calloc()

Returns a new VkAttachmentDescription2 instance allocated with memCalloc.

static VkAttachmentDescription2.Buffer

calloc(int capacity)

Returns a new VkAttachmentDescription2.Buffer instance allocated with memCalloc.

static VkAttachmentDescription2.Buffer

calloc(int capacity, MemoryStack stack)

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

static VkAttachmentDescription2

calloc(MemoryStack stack)

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

static VkAttachmentDescription2

create()

Returns a new VkAttachmentDescription2 instance allocated with BufferUtils.

static VkAttachmentDescription2.Buffer

create(int capacity)

Returns a new VkAttachmentDescription2.Buffer instance allocated with BufferUtils.

static VkAttachmentDescription2

create(long address)

Returns a new VkAttachmentDescription2 instance for the specified memory address.

static VkAttachmentDescription2.Buffer

create(long address, int capacity)

Create a VkAttachmentDescription2.Buffer instance at the specified memory.

static @Nullable VkAttachmentDescription2

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkAttachmentDescription2.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

finalLayout()

VkAttachmentDescription2

finalLayout(int value)

Sets the specified value to the finalLayout field.

int

flags()

VkAttachmentDescription2

flags(int value)

Sets the specified value to the flags field.

int

format()

VkAttachmentDescription2

format(int value)

Sets the specified value to the format field.

int

initialLayout()

VkAttachmentDescription2

initialLayout(int value)

Sets the specified value to the initialLayout field.

int

loadOp()

VkAttachmentDescription2

loadOp(int value)

Sets the specified value to the loadOp field.

static VkAttachmentDescription2

malloc()

Returns a new VkAttachmentDescription2 instance allocated with memAlloc.

static VkAttachmentDescription2.Buffer

malloc(int capacity)

Returns a new VkAttachmentDescription2.Buffer instance allocated with memAlloc.

static VkAttachmentDescription2.Buffer

malloc(int capacity, MemoryStack stack)

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

static VkAttachmentDescription2

malloc(MemoryStack stack)

Returns a new VkAttachmentDescription2 instance allocated on the specified MemoryStack.

static int

nfinalLayout(long struct)

Unsafe version of finalLayout().

static void

nfinalLayout(long struct, int value)

Unsafe version of finalLayout.

static int

nflags(long struct)

Unsafe version of flags().

static void

nflags(long struct, int value)

Unsafe version of flags.

static int

nformat(long struct)

Unsafe version of format().

static void

nformat(long struct, int value)

Unsafe version of format.

static int

ninitialLayout(long struct)

Unsafe version of initialLayout().

static void

ninitialLayout(long struct, int value)

Unsafe version of initialLayout.

static int

nloadOp(long struct)

Unsafe version of loadOp().

static void

nloadOp(long struct, int value)

Unsafe version of loadOp.

static long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

static int

nsamples(long struct)

Unsafe version of samples().

static void

nsamples(long struct, int value)

Unsafe version of samples.

static int

nstencilLoadOp(long struct)

Unsafe version of stencilLoadOp().

static void

nstencilLoadOp(long struct, int value)

Unsafe version of stencilLoadOp.

static int

nstencilStoreOp(long struct)

Unsafe version of stencilStoreOp().

static void

nstencilStoreOp(long struct, int value)

Unsafe version of stencilStoreOp.

static int

nstoreOp(long struct)

Unsafe version of storeOp().

static void

nstoreOp(long struct, int value)

Unsafe version of storeOp.

static int

nsType(long struct)

Unsafe version of sType().

static void

nsType(long struct, int value)

Unsafe version of sType.

long

pNext()

VkAttachmentDescription2

pNext(long value)

Sets the specified value to the pNext field.

VkAttachmentDescription2

pNext(VkAttachmentDescriptionStencilLayout value)

Prepends the specified VkAttachmentDescriptionStencilLayout value to the pNext chain.

VkAttachmentDescription2

pNext(VkAttachmentDescriptionStencilLayoutKHR value)

Prepends the specified VkAttachmentDescriptionStencilLayoutKHR value to the pNext chain.

VkAttachmentDescription2

pNext(VkExternalFormatANDROID value)

Prepends the specified VkExternalFormatANDROID value to the pNext chain.

int

samples()

VkAttachmentDescription2

samples(int value)

Sets the specified value to the samples field.

VkAttachmentDescription2

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.

VkAttachmentDescription2

set(VkAttachmentDescription2 src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

int

stencilLoadOp()

VkAttachmentDescription2

stencilLoadOp(int value)

Sets the specified value to the stencilLoadOp field.

int

stencilStoreOp()

VkAttachmentDescription2

stencilStoreOp(int value)

Sets the specified value to the stencilStoreOp field.

int

storeOp()

VkAttachmentDescription2

storeOp(int value)

Sets the specified value to the storeOp field.

int

sType()

VkAttachmentDescription2

sType(int value)

Sets the specified value to the sType field.

VkAttachmentDescription2

sType$Default()

Sets the STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2 value to the sType field.

Methods inherited from class Struct
clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default
address, equals, hashCode, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource
close, free

Field Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- STYPE
  
  public static final int STYPE
  
  The struct member offsets.
- PNEXT
  
  public static final int PNEXT
  
  The struct member offsets.
- FLAGS
  
  public static final int FLAGS
  
  The struct member offsets.
- FORMAT
  
  public static final int FORMAT
  
  The struct member offsets.
- SAMPLES
  
  public static final int SAMPLES
  
  The struct member offsets.
- LOADOP
  
  public static final int LOADOP
  
  The struct member offsets.
- STOREOP
  
  public static final int STOREOP
  
  The struct member offsets.
- STENCILLOADOP
  
  public static final int STENCILLOADOP
  
  The struct member offsets.
- STENCILSTOREOP
  
  public static final int STENCILSTOREOP
  
  The struct member offsets.
- INITIALLAYOUT
  
  public static final int INITIALLAYOUT
  
  The struct member offsets.
- FINALLAYOUT
  
  public static final int FINALLAYOUT
  
  The struct member offsets.
Constructor Details
- VkAttachmentDescription2
  
  public VkAttachmentDescription2(ByteBuffer container)
  
  Creates a VkAttachmentDescription2 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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<VkAttachmentDescription2>
- sType
  
  @NativeType("VkStructureType") public int sType()
  
  Returns:
  
  the value of the sType field.
- pNext
  
  @NativeType("void const *") public long pNext()
  
  Returns:
  
  the value of the pNext field.
- flags
  
  @NativeType("VkAttachmentDescriptionFlags") public int flags()
  
  Returns:
  
  the value of the flags field.
- format
  
  @NativeType("VkFormat") public int format()
  
  Returns:
  
  the value of the format field.
- samples
  
  @NativeType("VkSampleCountFlagBits") public int samples()
  
  Returns:
  
  the value of the samples field.
- loadOp
  
  @NativeType("VkAttachmentLoadOp") public int loadOp()
  
  Returns:
  
  the value of the loadOp field.
- storeOp
  
  @NativeType("VkAttachmentStoreOp") public int storeOp()
  
  Returns:
  
  the value of the storeOp field.
- stencilLoadOp
  
  @NativeType("VkAttachmentLoadOp") public int stencilLoadOp()
  
  Returns:
  
  the value of the stencilLoadOp field.
- stencilStoreOp
  
  @NativeType("VkAttachmentStoreOp") public int stencilStoreOp()
  
  Returns:
  
  the value of the stencilStoreOp field.
- initialLayout
  
  @NativeType("VkImageLayout") public int initialLayout()
  
  Returns:
  
  the value of the initialLayout field.
- finalLayout
  
  @NativeType("VkImageLayout") public int finalLayout()
  
  Returns:
  
  the value of the finalLayout field.
- sType
  
  public VkAttachmentDescription2 sType(@NativeType("VkStructureType") int value)
  
  Sets the specified value to the sType field.
- sType$Default
  
  public VkAttachmentDescription2 sType$Default()
  
  Sets the STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2 value to the sType field.
- pNext
  
  public VkAttachmentDescription2 pNext(@NativeType("void const *") long value)
  
  Sets the specified value to the pNext field.
- pNext
  
  public VkAttachmentDescription2 pNext(VkAttachmentDescriptionStencilLayout value)
  
  Prepends the specified VkAttachmentDescriptionStencilLayout value to the pNext chain.
- pNext
  
  public VkAttachmentDescription2 pNext(VkAttachmentDescriptionStencilLayoutKHR value)
  
  Prepends the specified VkAttachmentDescriptionStencilLayoutKHR value to the pNext chain.
- pNext
  
  public VkAttachmentDescription2 pNext(VkExternalFormatANDROID value)
  
  Prepends the specified VkExternalFormatANDROID value to the pNext chain.
- flags
  
  public VkAttachmentDescription2 flags(@NativeType("VkAttachmentDescriptionFlags") int value)
  
  Sets the specified value to the flags field.
- format
  
  public VkAttachmentDescription2 format(@NativeType("VkFormat") int value)
  
  Sets the specified value to the format field.
- samples
  
  public VkAttachmentDescription2 samples(@NativeType("VkSampleCountFlagBits") int value)
  
  Sets the specified value to the samples field.
- loadOp
  
  public VkAttachmentDescription2 loadOp(@NativeType("VkAttachmentLoadOp") int value)
  
  Sets the specified value to the loadOp field.
- storeOp
  
  public VkAttachmentDescription2 storeOp(@NativeType("VkAttachmentStoreOp") int value)
  
  Sets the specified value to the storeOp field.
- stencilLoadOp
  
  public VkAttachmentDescription2 stencilLoadOp(@NativeType("VkAttachmentLoadOp") int value)
  
  Sets the specified value to the stencilLoadOp field.
- stencilStoreOp
  
  public VkAttachmentDescription2 stencilStoreOp(@NativeType("VkAttachmentStoreOp") int value)
  
  Sets the specified value to the stencilStoreOp field.
- initialLayout
  
  public VkAttachmentDescription2 initialLayout(@NativeType("VkImageLayout") int value)
  
  Sets the specified value to the initialLayout field.
- finalLayout
  
  public VkAttachmentDescription2 finalLayout(@NativeType("VkImageLayout") int value)
  
  Sets the specified value to the finalLayout field.
- set
  
  public VkAttachmentDescription2 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.
- set
  
  public VkAttachmentDescription2 set(VkAttachmentDescription2 src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkAttachmentDescription2 malloc()
  
  Returns a new VkAttachmentDescription2 instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkAttachmentDescription2 calloc()
  
  Returns a new VkAttachmentDescription2 instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkAttachmentDescription2 create()
  
  Returns a new VkAttachmentDescription2 instance allocated with BufferUtils.
- create
  
  public static VkAttachmentDescription2 create(long address)
  
  Returns a new VkAttachmentDescription2 instance for the specified memory address.
- createSafe
  
  public static @Nullable VkAttachmentDescription2 createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkAttachmentDescription2.Buffer malloc(int capacity)
  
  Returns a new VkAttachmentDescription2.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkAttachmentDescription2.Buffer calloc(int capacity)
  
  Returns a new VkAttachmentDescription2.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkAttachmentDescription2.Buffer create(int capacity)
  
  Returns a new VkAttachmentDescription2.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkAttachmentDescription2.Buffer create(long address, int capacity)
  
  Create a VkAttachmentDescription2.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkAttachmentDescription2.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkAttachmentDescription2 malloc(MemoryStack stack)
  
  Returns a new VkAttachmentDescription2 instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkAttachmentDescription2 calloc(MemoryStack stack)
  
  Returns a new VkAttachmentDescription2 instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkAttachmentDescription2.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkAttachmentDescription2.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkAttachmentDescription2.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkAttachmentDescription2.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- nsType
  
  public static int nsType(long struct)
  
  Unsafe version of sType().
- npNext
  
  public static long npNext(long struct)
  
  Unsafe version of pNext().
- nflags
  
  public static int nflags(long struct)
  
  Unsafe version of flags().
- nformat
  
  public static int nformat(long struct)
  
  Unsafe version of format().
- nsamples
  
  public static int nsamples(long struct)
  
  Unsafe version of samples().
- nloadOp
  
  public static int nloadOp(long struct)
  
  Unsafe version of loadOp().
- nstoreOp
  
  public static int nstoreOp(long struct)
  
  Unsafe version of storeOp().
- nstencilLoadOp
  
  public static int nstencilLoadOp(long struct)
  
  Unsafe version of stencilLoadOp().
- nstencilStoreOp
  
  public static int nstencilStoreOp(long struct)
  
  Unsafe version of stencilStoreOp().
- ninitialLayout
  
  public static int ninitialLayout(long struct)
  
  Unsafe version of initialLayout().
- nfinalLayout
  
  public static int nfinalLayout(long struct)
  
  Unsafe version of finalLayout().
- nsType
  
  public static void nsType(long struct, int value)
  
  Unsafe version of sType.
- npNext
  
  public static void npNext(long struct, long value)
  
  Unsafe version of pNext.
- nflags
  
  public static void nflags(long struct, int value)
  
  Unsafe version of flags.
- nformat
  
  public static void nformat(long struct, int value)
  
  Unsafe version of format.
- nsamples
  
  public static void nsamples(long struct, int value)
  
  Unsafe version of samples.
- nloadOp
  
  public static void nloadOp(long struct, int value)
  
  Unsafe version of loadOp.
- nstoreOp
  
  public static void nstoreOp(long struct, int value)
  
  Unsafe version of storeOp.
- nstencilLoadOp
  
  public static void nstencilLoadOp(long struct, int value)
  
  Unsafe version of stencilLoadOp.
- nstencilStoreOp
  
  public static void nstencilStoreOp(long struct, int value)
  
  Unsafe version of stencilStoreOp.
- ninitialLayout
  
  public static void ninitialLayout(long struct, int value)
  
  Unsafe version of initialLayout.
- nfinalLayout
  
  public static void nfinalLayout(long struct, int value)
  
  Unsafe version of finalLayout.

Class VkAttachmentDescription2

Nested Class Summary

Nested classes/interfaces inherited from class Struct

Nested classes/interfaces inherited from interface Pointer

Field Summary

Fields inherited from interface Pointer

Constructor Summary

Method Summary

Methods inherited from class Struct

Methods inherited from class Pointer.Default

Methods inherited from class Object

Methods inherited from interface NativeResource

Field Details

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

FORMAT

SAMPLES

LOADOP

STOREOP

STENCILLOADOP

STENCILSTOREOP

INITIALLAYOUT

FINALLAYOUT

Constructor Details

VkAttachmentDescription2

Method Details

sizeof

sType

pNext

flags

format

samples

loadOp

storeOp

stencilLoadOp

stencilStoreOp

initialLayout

finalLayout

sType

sType$Default

pNext

pNext

pNext

pNext

flags

format

samples

loadOp

storeOp

stencilLoadOp

stencilStoreOp

initialLayout

finalLayout

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nformat

nsamples

nloadOp

nstoreOp

nstencilLoadOp