Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkSubpassBeginInfoKHR

extends VkSubpassBeginInfo
Class Inheritance
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
See VkSubpassBeginInfo.

Layout


struct VkSubpassBeginInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkSubpassContents contents;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
VkSubpassBeginInfoKHR.Buffer

An array of VkSubpassBeginInfoKHR structs.

Field Summary

Inherited from org.lwjgl.vulkan.VkSubpassBeginInfo:
ALIGNOFCONTENTSPNEXTSIZEOFSTYPE

Constructor Summary

AccessConstructor and Description
protected
VkSubpassBeginInfoKHR(long address, ByteBuffer container)

public
VkSubpassBeginInfoKHR(ByteBuffer container)

Creates a VkSubpassBeginInfoKHR instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static VkSubpassBeginInfoKHR
calloc()

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

Returns a new VkSubpassBeginInfoKHR instance allocated with memCalloc.
public static VkSubpassBeginInfoKHR.Buffer
calloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

Returns a new VkSubpassBeginInfoKHR.Buffer instance allocated with memCalloc.
public static VkSubpassBeginInfoKHR
calloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

Returns a new VkSubpassBeginInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkSubpassBeginInfoKHR.Buffer
calloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

Returns a new VkSubpassBeginInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
public static VkSubpassBeginInfoKHR
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassBeginInfoKHR
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassBeginInfoKHR.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassBeginInfoKHR.Buffer
callocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public VkSubpassBeginInfoKHR
contents(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.contents.

Sets the specified value to the contents field.
protected VkSubpassBeginInfoKHR
create(long
the struct memory address
address, ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static VkSubpassBeginInfoKHR
create()

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Returns a new VkSubpassBeginInfoKHR instance allocated with BufferUtils.
public static VkSubpassBeginInfoKHR
create(long address)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Returns a new VkSubpassBeginInfoKHR instance for the specified memory address.
public static VkSubpassBeginInfoKHR.Buffer
create(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Returns a new VkSubpassBeginInfoKHR.Buffer instance allocated with BufferUtils.
public static VkSubpassBeginInfoKHR.Buffer
create(long
the memory address
address, int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Create a VkSubpassBeginInfoKHR.Buffer instance at the specified memory.
public static VkSubpassBeginInfoKHR
createSafe(long address)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.createSafe.

Like create, but returns null if address is NULL.
public static VkSubpassBeginInfoKHR.Buffer
createSafe(long address, int capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.createSafe.

Like create, but returns null if address is NULL.
public static VkSubpassBeginInfoKHR
malloc()

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

Returns a new VkSubpassBeginInfoKHR instance allocated with memAlloc.
public static VkSubpassBeginInfoKHR.Buffer
malloc(int
the buffer capacity
capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

Returns a new VkSubpassBeginInfoKHR.Buffer instance allocated with memAlloc.
public static VkSubpassBeginInfoKHR
malloc(MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

Returns a new VkSubpassBeginInfoKHR instance allocated on the specified MemoryStack.
public static VkSubpassBeginInfoKHR.Buffer
malloc(int
the buffer capacity
capacity, MemoryStack
the stack from which to allocate
stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

Returns a new VkSubpassBeginInfoKHR.Buffer instance allocated on the specified MemoryStack.
public static VkSubpassBeginInfoKHR
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassBeginInfoKHR
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassBeginInfoKHR.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static VkSubpassBeginInfoKHR.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public VkSubpassBeginInfoKHR
pNext(long value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.pNext.

Sets the specified value to the pNext field.
public VkSubpassBeginInfoKHR
set(int sType, long pNext, int contents)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.set.

Initializes this struct with the specified values.
public VkSubpassBeginInfoKHR

Returns:

this struct
set(VkSubpassBeginInfoKHR
the source struct
src)

Copies the specified struct data to this struct.

public VkSubpassBeginInfoKHR
sType(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.sType.

Sets the specified value to the sType field.
public VkSubpassBeginInfoKHR
sType$Default()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.sType$Default.

Sets the STRUCTURE_TYPE_SUBPASS_BEGIN_INFO value to the sType field.
Inherited from org.lwjgl.vulkan.VkSubpassBeginInfo:
contentsncontentsncontentsnpNextnpNextnsTypensTypepNextsetsizeofsType

Constructor Detail

VkSubpassBeginInfoKHRback to summary
protected VkSubpassBeginInfoKHR(long address, ByteBuffer container)
VkSubpassBeginInfoKHRback to summary
public VkSubpassBeginInfoKHR(ByteBuffer container)

Creates a VkSubpassBeginInfoKHR 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

callocback to summary
public static VkSubpassBeginInfoKHR calloc()

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

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

callocback to summary
public static VkSubpassBeginInfoKHR.Buffer calloc(int capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkSubpassBeginInfoKHR calloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkSubpassBeginInfoKHR.Buffer calloc(int capacity, MemoryStack stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.calloc.

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static VkSubpassBeginInfoKHR callocStack()

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSubpassBeginInfoKHR callocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSubpassBeginInfoKHR.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static VkSubpassBeginInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
contentsback to summary
public VkSubpassBeginInfoKHR contents(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.contents.

Sets the specified value to the contents field.

Annotations
@Override
createback to summary
protected VkSubpassBeginInfoKHR create(long address, ByteBuffer container)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkSubpassBeginInfoKHR create()

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Returns a new VkSubpassBeginInfoKHR instance allocated with BufferUtils.

createback to summary
public static VkSubpassBeginInfoKHR create(long address)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Returns a new VkSubpassBeginInfoKHR instance for the specified memory address.

createback to summary
public static VkSubpassBeginInfoKHR.Buffer create(int capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Returns a new VkSubpassBeginInfoKHR.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkSubpassBeginInfoKHR.Buffer create(long address, int capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.create.

Create a VkSubpassBeginInfoKHR.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkSubpassBeginInfoKHR createSafe(long address)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.createSafe.

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkSubpassBeginInfoKHR.Buffer createSafe(long address, int capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.createSafe.

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkSubpassBeginInfoKHR malloc()

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

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

mallocback to summary
public static VkSubpassBeginInfoKHR.Buffer malloc(int capacity)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkSubpassBeginInfoKHR malloc(MemoryStack stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

Returns a new VkSubpassBeginInfoKHR instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkSubpassBeginInfoKHR.Buffer malloc(int capacity, MemoryStack stack)

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.malloc.

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static VkSubpassBeginInfoKHR mallocStack()

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSubpassBeginInfoKHR mallocStack(MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSubpassBeginInfoKHR.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static VkSubpassBeginInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
pNextback to summary
public VkSubpassBeginInfoKHR pNext(long value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
setback to summary
public VkSubpassBeginInfoKHR set(int sType, long pNext, int contents)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.set.

Initializes this struct with the specified values.

Annotations
@Override
setback to summary
public VkSubpassBeginInfoKHR set(VkSubpassBeginInfoKHR src)

Copies the specified struct data to this struct.

Parameters
src:VkSubpassBeginInfoKHR

the source struct

Returns:VkSubpassBeginInfoKHR

this struct

sTypeback to summary
public VkSubpassBeginInfoKHR sType(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkSubpassBeginInfoKHR sType$Default()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.sType$Default.

Sets the STRUCTURE_TYPE_SUBPASS_BEGIN_INFO value to the sType field.

Annotations
@Override
org.lwjgl.vulkan back to summary

public Class VkSubpassBeginInfoKHR.Buffer

extends Buffer
Class Inheritance
An array of VkSubpassBeginInfoKHR structs.

Field Summary

Modifier and TypeField and Description
private static final VkSubpassBeginInfoKHR
ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.ELEMENT_FACTORY.

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkSubpassBeginInfoKHR.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public VkSubpassBeginInfoKHR.Buffer
contents(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.contents.

Sets the specified value to the contents field.
protected VkSubpassBeginInfoKHR
getElementFactory()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.getElementFactory.

public VkSubpassBeginInfoKHR.Buffer
pNext(long value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.pNext.

Sets the specified value to the pNext field.
protected VkSubpassBeginInfoKHR.Buffer
self()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.self.

public VkSubpassBeginInfoKHR.Buffer
sType(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.sType.

Sets the specified value to the sType field.
public VkSubpassBeginInfoKHR.Buffer
sType$Default()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_SUBPASS_BEGIN_INFO value to the sType field.
Inherited from org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer:
contentspNextsType

Field Detail

ELEMENT_FACTORYback to summary
private static final VkSubpassBeginInfoKHR ELEMENT_FACTORY

Hides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.ELEMENT_FACTORY.

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkSubpassBeginInfoKHR.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkSubpassBeginInfoKHR#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

contentsback to summary
public VkSubpassBeginInfoKHR.Buffer contents(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.contents.

Sets the specified value to the contents field.

Annotations
@Override
getElementFactoryback to summary
protected VkSubpassBeginInfoKHR getElementFactory()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.getElementFactory.

Annotations
@Override
pNextback to summary
public VkSubpassBeginInfoKHR.Buffer pNext(long value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.pNext.

Sets the specified value to the pNext field.

Annotations
@Override
selfback to summary
protected VkSubpassBeginInfoKHR.Buffer self()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.self.

Annotations
@Override
sTypeback to summary
public VkSubpassBeginInfoKHR.Buffer sType(int value)

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.sType.

Sets the specified value to the sType field.

Annotations
@Override
sType$Defaultback to summary
public VkSubpassBeginInfoKHR.Buffer sType$Default()

Overrides org.lwjgl.vulkan.VkSubpassBeginInfo.Buffer.sType$Default.

Sets the STRUCTURE_TYPE_SUBPASS_BEGIN_INFO value to the sType field.

Annotations
@Override