org.lwjgl.vulkan.VkFramebufferCreateInfo

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

public class VkFramebufferCreateInfo extends Struct<VkFramebufferCreateInfo> implements NativeResource


 struct VkFramebufferCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkFramebufferCreateFlags flags;
     VkRenderPass renderPass;
     uint32_t attachmentCount;
     VkImageView const * pAttachments;
     uint32_t width;
     uint32_t height;
     uint32_t layers;
 }

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

VkFramebufferCreateInfo.Buffer

An array of VkFramebufferCreateInfo structs.

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

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

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

ATTACHMENTCOUNT

The struct member offsets.

static final int

FLAGS

The struct member offsets.

static final int

HEIGHT

The struct member offsets.

static final int

LAYERS

The struct member offsets.

static final int

PATTACHMENTS

The struct member offsets.

static final int

PNEXT

The struct member offsets.

static final int

RENDERPASS

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

STYPE

The struct member offsets.

static final int

WIDTH

The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

VkFramebufferCreateInfo(ByteBuffer container)

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

Modifier and Type

Method

Description

int

attachmentCount()

VkFramebufferCreateInfo

attachmentCount(int value)

Sets the specified value to the attachmentCount field.

static VkFramebufferCreateInfo

calloc()

Returns a new VkFramebufferCreateInfo instance allocated with memCalloc.

static VkFramebufferCreateInfo.Buffer

calloc(int capacity)

Returns a new VkFramebufferCreateInfo.Buffer instance allocated with memCalloc.

static VkFramebufferCreateInfo.Buffer

calloc(int capacity, MemoryStack stack)

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

static VkFramebufferCreateInfo

calloc(MemoryStack stack)

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

static VkFramebufferCreateInfo

callocStack()

Deprecated.

static VkFramebufferCreateInfo.Buffer

callocStack(int capacity)

Deprecated.

static VkFramebufferCreateInfo.Buffer

callocStack(int capacity, MemoryStack stack)

Deprecated.

static VkFramebufferCreateInfo

callocStack(MemoryStack stack)

Deprecated.

static VkFramebufferCreateInfo

create()

Returns a new VkFramebufferCreateInfo instance allocated with BufferUtils.

static VkFramebufferCreateInfo.Buffer

create(int capacity)

Returns a new VkFramebufferCreateInfo.Buffer instance allocated with BufferUtils.

static VkFramebufferCreateInfo

create(long address)

Returns a new VkFramebufferCreateInfo instance for the specified memory address.

static VkFramebufferCreateInfo.Buffer

create(long address, int capacity)

Create a VkFramebufferCreateInfo.Buffer instance at the specified memory.

static @Nullable VkFramebufferCreateInfo

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable VkFramebufferCreateInfo.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

int

flags()

VkFramebufferCreateInfo

flags(int value)

Sets the specified value to the flags field.

int

height()

VkFramebufferCreateInfo

height(int value)

Sets the specified value to the height field.

int

layers()

VkFramebufferCreateInfo

layers(int value)

Sets the specified value to the layers field.

static VkFramebufferCreateInfo

malloc()

Returns a new VkFramebufferCreateInfo instance allocated with memAlloc.

static VkFramebufferCreateInfo.Buffer

malloc(int capacity)

Returns a new VkFramebufferCreateInfo.Buffer instance allocated with memAlloc.

static VkFramebufferCreateInfo.Buffer

malloc(int capacity, MemoryStack stack)

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

static VkFramebufferCreateInfo

malloc(MemoryStack stack)

Returns a new VkFramebufferCreateInfo instance allocated on the specified MemoryStack.

static VkFramebufferCreateInfo

mallocStack()

Deprecated.

static VkFramebufferCreateInfo.Buffer

mallocStack(int capacity)

Deprecated.

static VkFramebufferCreateInfo.Buffer

mallocStack(int capacity, MemoryStack stack)

Deprecated.

static VkFramebufferCreateInfo

mallocStack(MemoryStack stack)

Deprecated.

static int

nattachmentCount(long struct)

Unsafe version of attachmentCount().

static void

nattachmentCount(long struct, int value)

Sets the specified value to the attachmentCount 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

nheight(long struct)

Unsafe version of height().

static void

nheight(long struct, int value)

Unsafe version of height.

static int

nlayers(long struct)

Unsafe version of layers().

static void

nlayers(long struct, int value)

Unsafe version of layers.

static @Nullable LongBuffer

npAttachments(long struct)

Unsafe version of pAttachments.

static void

npAttachments(long struct, @Nullable LongBuffer value)

Unsafe version of pAttachments.

static long

npNext(long struct)

Unsafe version of pNext().

static void

npNext(long struct, long value)

Unsafe version of pNext.

static long

nrenderPass(long struct)

Unsafe version of renderPass().

static void

nrenderPass(long struct, long value)

Unsafe version of renderPass.

static int

nsType(long struct)

Unsafe version of sType().

static void

nsType(long struct, int value)

Unsafe version of sType.

static int

nwidth(long struct)

Unsafe version of width().

static void

nwidth(long struct, int value)

Unsafe version of width.

@Nullable LongBuffer

pAttachments()

VkFramebufferCreateInfo

pAttachments(@Nullable LongBuffer value)

Sets the address of the specified LongBuffer to the pAttachments field.

long

pNext()

VkFramebufferCreateInfo

pNext(long value)

Sets the specified value to the pNext field.

VkFramebufferCreateInfo

pNext(VkFramebufferAttachmentsCreateInfo value)

Prepends the specified VkFramebufferAttachmentsCreateInfo value to the pNext chain.

VkFramebufferCreateInfo

pNext(VkFramebufferAttachmentsCreateInfoKHR value)

Prepends the specified VkFramebufferAttachmentsCreateInfoKHR value to the pNext chain.

long

renderPass()

VkFramebufferCreateInfo

renderPass(long value)

Sets the specified value to the renderPass field.

VkFramebufferCreateInfo

set(int sType, long pNext, int flags, long renderPass, int attachmentCount, @Nullable LongBuffer pAttachments, int width, int height, int layers)

Initializes this struct with the specified values.

VkFramebufferCreateInfo

set(VkFramebufferCreateInfo src)

Copies the specified struct data to this struct.

int

sizeof()

Returns sizeof(struct).

int

sType()

VkFramebufferCreateInfo

sType(int value)

Sets the specified value to the sType field.

VkFramebufferCreateInfo

sType$Default()

Sets the STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO value to the sType field.

int

width()

VkFramebufferCreateInfo

width(int value)

Sets the specified value to the width field.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validate

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.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.
- RENDERPASS
  
  public static final int RENDERPASS
  
  The struct member offsets.
- ATTACHMENTCOUNT
  
  public static final int ATTACHMENTCOUNT
  
  The struct member offsets.
- PATTACHMENTS
  
  public static final int PATTACHMENTS
  
  The struct member offsets.
- WIDTH
  
  public static final int WIDTH
  
  The struct member offsets.
- HEIGHT
  
  public static final int HEIGHT
  
  The struct member offsets.
- LAYERS
  
  public static final int LAYERS
  
  The struct member offsets.
Constructor Details
- VkFramebufferCreateInfo
  
  public VkFramebufferCreateInfo(ByteBuffer container)
  
  Creates a VkFramebufferCreateInfo 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<VkFramebufferCreateInfo>
- sType
  
  public int sType()
  
  Returns:
  
  the value of the sType field.
- pNext
  
  public long pNext()
  
  Returns:
  
  the value of the pNext field.
- flags
  
  public int flags()
  
  Returns:
  
  the value of the flags field.
- renderPass
  
  public long renderPass()
  
  Returns:
  
  the value of the renderPass field.
- attachmentCount
  
  public int attachmentCount()
  
  Returns:
  
  the value of the attachmentCount field.
- pAttachments
  
  public @Nullable LongBuffer pAttachments()
  
  Returns:
  
  a LongBuffer view of the data pointed to by the pAttachments field.
- width
  
  public int width()
  
  Returns:
  
  the value of the width field.
- height
  
  public int height()
  
  Returns:
  
  the value of the height field.
- layers
  
  public int layers()
  
  Returns:
  
  the value of the layers field.
- sType
  
  public VkFramebufferCreateInfo sType(int value)
  
  Sets the specified value to the sType field.
- sType$Default
  
  public VkFramebufferCreateInfo sType$Default()
  
  Sets the STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO value to the sType field.
- pNext
  
  public VkFramebufferCreateInfo pNext(long value)
  
  Sets the specified value to the pNext field.
- pNext
  
  public VkFramebufferCreateInfo pNext(VkFramebufferAttachmentsCreateInfo value)
  
  Prepends the specified VkFramebufferAttachmentsCreateInfo value to the pNext chain.
- pNext
  
  public VkFramebufferCreateInfo pNext(VkFramebufferAttachmentsCreateInfoKHR value)
  
  Prepends the specified VkFramebufferAttachmentsCreateInfoKHR value to the pNext chain.
- flags
  
  public VkFramebufferCreateInfo flags(int value)
  
  Sets the specified value to the flags field.
- renderPass
  
  public VkFramebufferCreateInfo renderPass(long value)
  
  Sets the specified value to the renderPass field.
- attachmentCount
  
  public VkFramebufferCreateInfo attachmentCount(int value)
  
  Sets the specified value to the attachmentCount field.
- pAttachments
  
  public VkFramebufferCreateInfo pAttachments(@Nullable LongBuffer value)
  
  Sets the address of the specified LongBuffer to the pAttachments field.
- width
  
  public VkFramebufferCreateInfo width(int value)
  
  Sets the specified value to the width field.
- height
  
  public VkFramebufferCreateInfo height(int value)
  
  Sets the specified value to the height field.
- layers
  
  public VkFramebufferCreateInfo layers(int value)
  
  Sets the specified value to the layers field.
- set
  
  public VkFramebufferCreateInfo set(int sType, long pNext, int flags, long renderPass, int attachmentCount, @Nullable LongBuffer pAttachments, int width, int height, int layers)
  
  Initializes this struct with the specified values.
- set
  
  public VkFramebufferCreateInfo set(VkFramebufferCreateInfo src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static VkFramebufferCreateInfo malloc()
  
  Returns a new VkFramebufferCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static VkFramebufferCreateInfo calloc()
  
  Returns a new VkFramebufferCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static VkFramebufferCreateInfo create()
  
  Returns a new VkFramebufferCreateInfo instance allocated with BufferUtils.
- create
  
  public static VkFramebufferCreateInfo create(long address)
  
  Returns a new VkFramebufferCreateInfo instance for the specified memory address.
- createSafe
  
  public static @Nullable VkFramebufferCreateInfo createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static VkFramebufferCreateInfo.Buffer malloc(int capacity)
  
  Returns a new VkFramebufferCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static VkFramebufferCreateInfo.Buffer calloc(int capacity)
  
  Returns a new VkFramebufferCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkFramebufferCreateInfo.Buffer create(int capacity)
  
  Returns a new VkFramebufferCreateInfo.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static VkFramebufferCreateInfo.Buffer create(long address, int capacity)
  
  Create a VkFramebufferCreateInfo.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable VkFramebufferCreateInfo.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- mallocStack
  
  @Deprecated public static VkFramebufferCreateInfo mallocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkFramebufferCreateInfo callocStack()
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkFramebufferCreateInfo mallocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkFramebufferCreateInfo callocStack(MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkFramebufferCreateInfo.Buffer mallocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkFramebufferCreateInfo.Buffer callocStack(int capacity)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- mallocStack
  
  @Deprecated public static VkFramebufferCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.
- callocStack
  
  @Deprecated public static VkFramebufferCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
  
  Deprecated.
  
  Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.
- malloc
  
  public static VkFramebufferCreateInfo malloc(MemoryStack stack)
  
  Returns a new VkFramebufferCreateInfo instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  public static VkFramebufferCreateInfo calloc(MemoryStack stack)
  
  Returns a new VkFramebufferCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
  
  Parameters:
  
  stack - the stack from which to allocate
- malloc
  
  public static VkFramebufferCreateInfo.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new VkFramebufferCreateInfo.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  public static VkFramebufferCreateInfo.Buffer calloc(int capacity, MemoryStack stack)
  
  Returns a new VkFramebufferCreateInfo.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().
- nrenderPass
  
  public static long nrenderPass(long struct)
  
  Unsafe version of renderPass().
- nattachmentCount
  
  public static int nattachmentCount(long struct)
  
  Unsafe version of attachmentCount().
- npAttachments
  
  public static @Nullable LongBuffer npAttachments(long struct)
  
  Unsafe version of pAttachments.
- nwidth
  
  public static int nwidth(long struct)
  
  Unsafe version of width().
- nheight
  
  public static int nheight(long struct)
  
  Unsafe version of height().
- nlayers
  
  public static int nlayers(long struct)
  
  Unsafe version of layers().
- 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.
- nrenderPass
  
  public static void nrenderPass(long struct, long value)
  
  Unsafe version of renderPass.
- nattachmentCount
  
  public static void nattachmentCount(long struct, int value)
  
  Sets the specified value to the attachmentCount field of the specified struct.
- npAttachments
  
  public static void npAttachments(long struct, @Nullable LongBuffer value)
  
  Unsafe version of pAttachments.
- nwidth
  
  public static void nwidth(long struct, int value)
  
  Unsafe version of width.
- nheight
  
  public static void nheight(long struct, int value)
  
  Unsafe version of height.
- nlayers
  
  public static void nlayers(long struct, int value)
  
  Unsafe version of layers.

Class VkFramebufferCreateInfo

Nested Class Summary

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

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

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Details

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

RENDERPASS

ATTACHMENTCOUNT

PATTACHMENTS

WIDTH

HEIGHT

LAYERS

Constructor Details

VkFramebufferCreateInfo

Method Details

sizeof

sType

pNext

flags

renderPass

attachmentCount

pAttachments

width

height

layers

sType

sType$Default

pNext

pNext

pNext

flags

renderPass

attachmentCount

pAttachments

width

height

layers

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

malloc

calloc

malloc

calloc

nsType

npNext

nflags

nrenderPass

nattachmentCount

npAttachments

nwidth