org.lwjgl.vulkan.VkSubpassDescription

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VkSubpassDescription extends Struct<VkSubpassDescription> implements NativeResource

struct VkSubpassDescription {
    VkSubpassDescriptionFlags flags;
    VkPipelineBindPoint pipelineBindPoint;
    uint32_t inputAttachmentCount;
    VkAttachmentReference const * pInputAttachments;
    uint32_t colorAttachmentCount;
    VkAttachmentReference const * pColorAttachments;
    VkAttachmentReference const * pResolveAttachments;
    VkAttachmentReference const * pDepthStencilAttachment;
    uint32_t preserveAttachmentCount;
    uint32_t const * pPreserveAttachments;
}

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkSubpassDescription.Buffer

An array of VkSubpassDescription 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

COLORATTACHMENTCOUNT

The struct member offsets.

static final int

FLAGS

The struct member offsets.

static final int

INPUTATTACHMENTCOUNT

The struct member offsets.

static final int

PCOLORATTACHMENTS

The struct member offsets.

static final int

PDEPTHSTENCILATTACHMENT

The struct member offsets.

static final int

PINPUTATTACHMENTS

The struct member offsets.

static final int

PIPELINEBINDPOINT

The struct member offsets.

static final int

PPRESERVEATTACHMENTS

The struct member offsets.

static final int

PRESERVEATTACHMENTCOUNT

The struct member offsets.

static final int

PRESOLVEATTACHMENTS

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

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

Constructors

Constructor

Description

VkSubpassDescription(ByteBuffer container)

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

Modifier and Type

Method

Description

static VkSubpassDescription

calloc()

Returns a new VkSubpassDescription instance allocated with memCalloc.

static VkSubpassDescription.Buffer

calloc(int capacity)

Returns a new VkSubpassDescription.Buffer instance allocated with memCalloc.

static VkSubpassDescription.Buffer

calloc(int capacity, MemoryStack stack)

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

static VkSubpassDescription

calloc(MemoryStack stack)

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

int

colorAttachmentCount()

VkSubpassDescription

colorAttachmentCount(int value)

Sets the specified value to the colorAttachmentCount field.

static VkSubpassDescription

create()

Returns a new VkSubpassDescription instance allocated with BufferUtils.

static VkSubpassDescription.Buffer

create(int capacity)

Returns a new VkSubpassDescription.Buffer instance allocated with BufferUtils.

static VkSubpassDescription

create(long address)

Returns a new VkSubpassDescription instance for the specified memory address.

static VkSubpassDescription.Buffer

create(long address, int capacity)

Create a VkSubpassDescription.Buffer instance at the specified memory.

static @Nullable VkSubpassDescription

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkSubpassDescription.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

flags()

VkSubpassDescription

flags(int value)

Sets the specified value to the flags field.

int

inputAttachmentCount()

static VkSubpassDescription

malloc()

Returns a new VkSubpassDescription instance allocated with memAlloc.

static VkSubpassDescription.Buffer

malloc(int capacity)

Returns a new VkSubpassDescription.Buffer instance allocated with memAlloc.

static VkSubpassDescription.Buffer

malloc(int capacity, MemoryStack stack)

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

static VkSubpassDescription

malloc(MemoryStack stack)

Returns a new VkSubpassDescription instance allocated on the specified MemoryStack.

static int

ncolorAttachmentCount(long struct)

Unsafe version of colorAttachmentCount().

static void

ncolorAttachmentCount(long struct, int value)

Sets the specified value to the colorAttachmentCount field of the specified struct.

static int

nflags(long struct)

Unsafe version of flags().

static void

nflags(long struct, int value)

Unsafe version of flags.

static int

ninputAttachmentCount(long struct)

Unsafe version of inputAttachmentCount().

static void

ninputAttachmentCount(long struct, int value)

Sets the specified value to the inputAttachmentCount field of the specified struct.

static @Nullable VkAttachmentReference.Buffer

npColorAttachments(long struct)

Unsafe version of pColorAttachments().

static void

npColorAttachments(long struct, @Nullable VkAttachmentReference.Buffer value)

Unsafe version of pColorAttachments.

static @Nullable VkAttachmentReference

npDepthStencilAttachment(long struct)

Unsafe version of pDepthStencilAttachment().

static void

npDepthStencilAttachment(long struct, @Nullable VkAttachmentReference value)

Unsafe version of pDepthStencilAttachment.

static @Nullable VkAttachmentReference.Buffer

npInputAttachments(long struct)

Unsafe version of pInputAttachments().

static void

npInputAttachments(long struct, @Nullable VkAttachmentReference.Buffer value)

Unsafe version of pInputAttachments.

static int

npipelineBindPoint(long struct)

Unsafe version of pipelineBindPoint().

static void

npipelineBindPoint(long struct, int value)

Unsafe version of pipelineBindPoint.

static @Nullable IntBuffer

npPreserveAttachments(long struct)

Unsafe version of pPreserveAttachments.

static void

npPreserveAttachments(long struct, @Nullable IntBuffer value)

Unsafe version of pPreserveAttachments.

static int

npreserveAttachmentCount(long struct)

Unsafe version of preserveAttachmentCount().

static void

npreserveAttachmentCount(long struct, int value)

Sets the specified value to the preserveAttachmentCount field of the specified struct.

static @Nullable VkAttachmentReference.Buffer

npResolveAttachments(long struct)

Unsafe version of pResolveAttachments().

static void

npResolveAttachments(long struct, @Nullable VkAttachmentReference.Buffer value)

Unsafe version of pResolveAttachments.

@Nullable VkAttachmentReference.Buffer

pColorAttachments()

VkSubpassDescription

pColorAttachments(@Nullable VkAttachmentReference.Buffer value)

Sets the address of the specified VkAttachmentReference.Buffer to the pColorAttachments field.

@Nullable VkAttachmentReference

pDepthStencilAttachment()

VkSubpassDescription

pDepthStencilAttachment(@Nullable VkAttachmentReference value)

Sets the address of the specified VkAttachmentReference to the pDepthStencilAttachment field.

@Nullable VkAttachmentReference.Buffer

pInputAttachments()

VkSubpassDescription

pInputAttachments(@Nullable VkAttachmentReference.Buffer value)

Sets the address of the specified VkAttachmentReference.Buffer to the pInputAttachments field.

int

pipelineBindPoint()

VkSubpassDescription

pipelineBindPoint(int value)

Sets the specified value to the pipelineBindPoint field.

@Nullable IntBuffer

pPreserveAttachments()

VkSubpassDescription

pPreserveAttachments(@Nullable IntBuffer value)

Sets the address of the specified IntBuffer to the pPreserveAttachments field.

int

preserveAttachmentCount()

@Nullable VkAttachmentReference.Buffer

pResolveAttachments()

VkSubpassDescription

pResolveAttachments(@Nullable VkAttachmentReference.Buffer value)

Sets the address of the specified VkAttachmentReference.Buffer to the pResolveAttachments field.

VkSubpassDescription

set(int flags, int pipelineBindPoint, @Nullable VkAttachmentReference.Buffer pInputAttachments, int colorAttachmentCount, @Nullable VkAttachmentReference.Buffer pColorAttachments, @Nullable VkAttachmentReference.Buffer pResolveAttachments, @Nullable VkAttachmentReference pDepthStencilAttachment, @Nullable IntBuffer pPreserveAttachments)

Initializes this struct with the specified values.

VkSubpassDescription

set(VkSubpassDescription src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

static void

validate(long struct)

Validates pointer members that should not be NULL.

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.
- FLAGS
  
  public static final int FLAGS
  
  The struct member offsets.
- PIPELINEBINDPOINT
  
  public static final int PIPELINEBINDPOINT
  
  The struct member offsets.
- INPUTATTACHMENTCOUNT
  
  public static final int INPUTATTACHMENTCOUNT
  
  The struct member offsets.
- PINPUTATTACHMENTS
  
  public static final int PINPUTATTACHMENTS
  
  The struct member offsets.
- COLORATTACHMENTCOUNT
  
  public static final int COLORATTACHMENTCOUNT
  
  The struct member offsets.
- PCOLORATTACHMENTS
  
  public static final int PCOLORATTACHMENTS
  
  The struct member offsets.
- PRESOLVEATTACHMENTS
  
  public static final int PRESOLVEATTACHMENTS
  
  The struct member offsets.
- PDEPTHSTENCILATTACHMENT
  
  public static final int PDEPTHSTENCILATTACHMENT
  
  The struct member offsets.
- PRESERVEATTACHMENTCOUNT
  
  public static final int PRESERVEATTACHMENTCOUNT
  
  The struct member offsets.
- PPRESERVEATTACHMENTS
  
  public static final int PPRESERVEATTACHMENTS
  
  The struct member offsets.
Constructor Details
- VkSubpassDescription
  
  public VkSubpassDescription(ByteBuffer container)
  
  Creates a VkSubpassDescription 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<VkSubpassDescription>
- flags
  
  @NativeType("VkSubpassDescriptionFlags") public int flags()
  
  Returns:
  
  the value of the flags field.
- pipelineBindPoint
  
  @NativeType("VkPipelineBindPoint") public int pipelineBindPoint()
  
  Returns:
  
  the value of the pipelineBindPoint field.
- inputAttachmentCount
  
  @NativeType("uint32_t") public int inputAttachmentCount()
  
  Returns:
  
  the value of the inputAttachmentCount field.
- pInputAttachments
  
  @NativeType("VkAttachmentReference const *") public @Nullable VkAttachmentReference.Buffer pInputAttachments()
  
  Returns:
  
  a VkAttachmentReference.Buffer view of the struct array pointed to by the pInputAttachments field.
- colorAttachmentCount
  
  @NativeType("uint32_t") public int colorAttachmentCount()
  
  Returns:
  
  the value of the colorAttachmentCount field.
- pColorAttachments
  
  @NativeType("VkAttachmentReference const *") public @Nullable VkAttachmentReference.Buffer pColorAttachments()
  
  Returns:
  
  a VkAttachmentReference.Buffer view of the struct array pointed to by the pColorAttachments field.
- pResolveAttachments
  
  @NativeType("VkAttachmentReference const *") public @Nullable VkAttachmentReference.Buffer pResolveAttachments()
  
  Returns:
  
  a VkAttachmentReference.Buffer view of the struct array pointed to by the pResolveAttachments field.
- pDepthStencilAttachment
  
  @NativeType("VkAttachmentReference const *") public @Nullable VkAttachmentReference pDepthStencilAttachment()
  
  Returns:
  
  a VkAttachmentReference view of the struct pointed to by the pDepthStencilAttachment field.
- preserveAttachmentCount
  
  @NativeType("uint32_t") public int preserveAttachmentCount()
  
  Returns:
  
  the value of the preserveAttachmentCount field.
- pPreserveAttachments
  
  @NativeType("uint32_t const *") public @Nullable IntBuffer pPreserveAttachments()
  
  Returns:
  
  a IntBuffer view of the data pointed to by the pPreserveAttachments field.
- flags
  
  public VkSubpassDescription flags(@NativeType("VkSubpassDescriptionFlags") int value)
  
  Sets the specified value to the flags field.
- pipelineBindPoint
  
  public VkSubpassDescription pipelineBindPoint(@NativeType("VkPipelineBindPoint") int value)
  
  Sets the specified value to the pipelineBindPoint field.
- pInputAttachments
  
  public VkSubpassDescription pInputAttachments(@NativeType("VkAttachmentReference const *") @Nullable VkAttachmentReference.Buffer value)
  
  Sets the address of the specified VkAttachmentReference.Buffer to the pInputAttachments field.
- colorAttachmentCount
  
  public VkSubpassDescription colorAttachmentCount(@NativeType("uint32_t") int value)
  
  Sets the specified value to the colorAttachmentCount field.
- pColorAttachments
  
  public VkSubpassDescription pColorAttachments(@NativeType("VkAttachmentReference const *") @Nullable VkAttachmentReference.Buffer value)
  
  Sets the address of the specified VkAttachmentReference.Buffer to the pColorAttachments field.
- pResolveAttachments
  
  public VkSubpassDescription pResolveAttachments(@NativeType("VkAttachmentReference const *") @Nullable VkAttachmentReference.Buffer value)
  
  Sets the address of the specified VkAttachmentReference.Buffer to the pResolveAttachments field.
- pDepthStencilAttachment
  
  public VkSubpassDescription pDepthStencilAttachment(@NativeType("VkAttachmentReference const *") @Nullable VkAttachmentReference value)
  
  Sets the address of the specified VkAttachmentReference to the pDepthStencilAttachment field.
- pPreserveAttachments
  
  public VkSubpassDescription pPreserveAttachments(@NativeType("uint32_t const *") @Nullable IntBuffer value)
  
  Sets the address of the specified IntBuffer to the pPreserveAttachments field.
- set
  
  public VkSubpassDescription set(int flags, int pipelineBindPoint, @Nullable VkAttachmentReference.Buffer pInputAttachments, int colorAttachmentCount, @Nullable VkAttachmentReference.Buffer pColorAttachments, @Nullable VkAttachmentReference.Buffer pResolveAttachments, @Nullable VkAttachmentReference pDepthStencilAttachment, @Nullable IntBuffer pPreserveAttachments)
  
  Initializes this struct with the specified values.
- set
  
  public VkSubpassDescription set(VkSubpassDescription src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkSubpassDescription malloc()
  
  Returns a new VkSubpassDescription instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkSubpassDescription calloc()
  
  Returns a new VkSubpassDescription instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkSubpassDescription create()
  
  Returns a new VkSubpassDescription instance allocated with BufferUtils.
- create
  
  public static VkSubpassDescription create(long address)
  
  Returns a new VkSubpassDescription instance for the specified memory address.
- createSafe
  
  public static @Nullable VkSubpassDescription createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkSubpassDescription.Buffer malloc(int capacity)
  
  Returns a new VkSubpassDescription.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkSubpassDescription.Buffer calloc(int capacity)
  
  Returns a new VkSubpassDescription.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkSubpassDescription.Buffer create(int capacity)
  
  Returns a new VkSubpassDescription.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkSubpassDescription.Buffer create(long address, int capacity)
  
  Create a VkSubpassDescription.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkSubpassDescription.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkSubpassDescription malloc(MemoryStack stack)
  
  Returns a new VkSubpassDescription instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkSubpassDescription calloc(MemoryStack stack)
  
  Returns a new VkSubpassDescription instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkSubpassDescription.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkSubpassDescription.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkSubpassDescription.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkSubpassDescription.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
- nflags
  
  public static int nflags(long struct)
  
  Unsafe version of flags().
- npipelineBindPoint
  
  public static int npipelineBindPoint(long struct)
  
  Unsafe version of pipelineBindPoint().
- ninputAttachmentCount
  
  public static int ninputAttachmentCount(long struct)
  
  Unsafe version of inputAttachmentCount().
- npInputAttachments
  
  public static @Nullable VkAttachmentReference.Buffer npInputAttachments(long struct)
  
  Unsafe version of pInputAttachments().
- ncolorAttachmentCount
  
  public static int ncolorAttachmentCount(long struct)
  
  Unsafe version of colorAttachmentCount().
- npColorAttachments
  
  public static @Nullable VkAttachmentReference.Buffer npColorAttachments(long struct)
  
  Unsafe version of pColorAttachments().
- npResolveAttachments
  
  public static @Nullable VkAttachmentReference.Buffer npResolveAttachments(long struct)
  
  Unsafe version of pResolveAttachments().
- npDepthStencilAttachment
  
  public static @Nullable VkAttachmentReference npDepthStencilAttachment(long struct)
  
  Unsafe version of pDepthStencilAttachment().
- npreserveAttachmentCount
  
  public static int npreserveAttachmentCount(long struct)
  
  Unsafe version of preserveAttachmentCount().
- npPreserveAttachments
  
  public static @Nullable IntBuffer npPreserveAttachments(long struct)
  
  Unsafe version of pPreserveAttachments.
- nflags
  
  public static void nflags(long struct, int value)
  
  Unsafe version of flags.
- npipelineBindPoint
  
  public static void npipelineBindPoint(long struct, int value)
  
  Unsafe version of pipelineBindPoint.
- ninputAttachmentCount
  
  public static void ninputAttachmentCount(long struct, int value)
  
  Sets the specified value to the inputAttachmentCount field of the specified struct.
- npInputAttachments
  
  public static void npInputAttachments(long struct, @Nullable VkAttachmentReference.Buffer value)
  
  Unsafe version of pInputAttachments.
- ncolorAttachmentCount
  
  public static void ncolorAttachmentCount(long struct, int value)
  
  Sets the specified value to the colorAttachmentCount field of the specified struct.
- npColorAttachments
  
  public static void npColorAttachments(long struct, @Nullable VkAttachmentReference.Buffer value)
  
  Unsafe version of pColorAttachments.
- npResolveAttachments
  
  public static void npResolveAttachments(long struct, @Nullable VkAttachmentReference.Buffer value)
  
  Unsafe version of pResolveAttachments.
- npDepthStencilAttachment
  
  public static void npDepthStencilAttachment(long struct, @Nullable VkAttachmentReference value)
  
  Unsafe version of pDepthStencilAttachment.
- npreserveAttachmentCount
  
  public static void npreserveAttachmentCount(long struct, int value)
  
  Sets the specified value to the preserveAttachmentCount field of the specified struct.
- npPreserveAttachments
  
  public static void npPreserveAttachments(long struct, @Nullable IntBuffer value)
  
  Unsafe version of pPreserveAttachments.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class VkSubpassDescription

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

FLAGS

PIPELINEBINDPOINT

INPUTATTACHMENTCOUNT

PINPUTATTACHMENTS

COLORATTACHMENTCOUNT

PCOLORATTACHMENTS

PRESOLVEATTACHMENTS

PDEPTHSTENCILATTACHMENT

PRESERVEATTACHMENTCOUNT

PPRESERVEATTACHMENTS

Constructor Details

VkSubpassDescription

Method Details

sizeof

flags

pipelineBindPoint

inputAttachmentCount

pInputAttachments

colorAttachmentCount

pColorAttachments

pResolveAttachments

pDepthStencilAttachment

preserveAttachmentCount

pPreserveAttachments

flags

pipelineBindPoint

pInputAttachments

colorAttachmentCount

pColorAttachments

pResolveAttachments

pDepthStencilAttachment

pPreserveAttachments

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

nflags

npipelineBindPoint

ninputAttachmentCount

npInputAttachments

ncolorAttachmentCount

npColorAttachments

npResolveAttachments

npDepthStencilAttachment

npreserveAttachmentCount

npPreserveAttachments

nflags

npipelineBindPoint

ninputAttachmentCount

npInputAttachments

ncolorAttachmentCount

npColorAttachments

npResolveAttachments