Class VkDisplaySurfaceCreateInfoKHR

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkDisplaySurfaceCreateInfoKHR>

org.lwjgl.vulkan.VkDisplaySurfaceCreateInfoKHR

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class VkDisplaySurfaceCreateInfoKHR
extends Struct<VkDisplaySurfaceCreateInfoKHR>
implements NativeResource

struct VkDisplaySurfaceCreateInfoKHR {
    VkStructureType sType;
    void const * pNext;
    VkDisplaySurfaceCreateFlagsKHR flags;
    VkDisplayModeKHR displayMode;
    uint32_t planeIndex;
    uint32_t planeStackIndex;
    VkSurfaceTransformFlagBitsKHR transform;
    float globalAlpha;
    VkDisplayPlaneAlphaFlagBitsKHR alphaMode;
    VkExtent2D imageExtent;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkDisplaySurfaceCreateInfoKHR.Buffer	An array of VkDisplaySurfaceCreateInfoKHR 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	ALPHAMODE	The struct member offsets.
static final int	DISPLAYMODE	The struct member offsets.
static final int	FLAGS	The struct member offsets.
static final int	GLOBALALPHA	The struct member offsets.
static final int	IMAGEEXTENT	The struct member offsets.
static final int	PLANEINDEX	The struct member offsets.
static final int	PLANESTACKINDEX	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	STYPE	The struct member offsets.
static final int	TRANSFORM	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	alphaMode()
VkDisplaySurfaceCreateInfoKHR	alphaMode(int value)	Sets the specified value to the alphaMode field.
static VkDisplaySurfaceCreateInfoKHR	calloc()	Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated with memCalloc.
static VkDisplaySurfaceCreateInfoKHR.Buffer	calloc(int capacity)	Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with memCalloc.
static VkDisplaySurfaceCreateInfoKHR.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplaySurfaceCreateInfoKHR	calloc(MemoryStack stack)	Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkDisplaySurfaceCreateInfoKHR	create()	Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated with BufferUtils.
static VkDisplaySurfaceCreateInfoKHR.Buffer	create(int capacity)	Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.
static VkDisplaySurfaceCreateInfoKHR	create(long address)	Returns a new VkDisplaySurfaceCreateInfoKHR instance for the specified memory address.
static VkDisplaySurfaceCreateInfoKHR.Buffer	create(long address, int capacity)	Create a VkDisplaySurfaceCreateInfoKHR.Buffer instance at the specified memory.
static @Nullable VkDisplaySurfaceCreateInfoKHR	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkDisplaySurfaceCreateInfoKHR.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	displayMode()
VkDisplaySurfaceCreateInfoKHR	displayMode(long value)	Sets the specified value to the displayMode field.
int	flags()
VkDisplaySurfaceCreateInfoKHR	flags(int value)	Sets the specified value to the flags field.
float	globalAlpha()
VkDisplaySurfaceCreateInfoKHR	globalAlpha(float value)	Sets the specified value to the globalAlpha field.
VkExtent2D	imageExtent()
VkDisplaySurfaceCreateInfoKHR	imageExtent(Consumer<VkExtent2D> consumer)	Passes the imageExtent field to the specified Consumer.
VkDisplaySurfaceCreateInfoKHR	imageExtent(VkExtent2D value)	Copies the specified VkExtent2D to the imageExtent field.
static VkDisplaySurfaceCreateInfoKHR	malloc()	Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated with memAlloc.
static VkDisplaySurfaceCreateInfoKHR.Buffer	malloc(int capacity)	Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with memAlloc.
static VkDisplaySurfaceCreateInfoKHR.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated on the specified MemoryStack.
static VkDisplaySurfaceCreateInfoKHR	malloc(MemoryStack stack)	Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack.
static int	nalphaMode(long struct)	Unsafe version of alphaMode().
static void	nalphaMode(long struct, int value)	Unsafe version of alphaMode.
static long	ndisplayMode(long struct)	Unsafe version of displayMode().
static void	ndisplayMode(long struct, long value)	Unsafe version of displayMode.
static int	nflags(long struct)	Unsafe version of flags().
static void	nflags(long struct, int value)	Unsafe version of flags.
static float	nglobalAlpha(long struct)	Unsafe version of globalAlpha().
static void	nglobalAlpha(long struct, float value)	Unsafe version of globalAlpha.
static VkExtent2D	nimageExtent(long struct)	Unsafe version of imageExtent().
static void	nimageExtent(long struct, VkExtent2D value)	Unsafe version of imageExtent.
static int	nplaneIndex(long struct)	Unsafe version of planeIndex().
static void	nplaneIndex(long struct, int value)	Unsafe version of planeIndex.
static int	nplaneStackIndex(long struct)	Unsafe version of planeStackIndex().
static void	nplaneStackIndex(long struct, int value)	Unsafe version of planeStackIndex.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
static int	ntransform(long struct)	Unsafe version of transform().
static void	ntransform(long struct, int value)	Unsafe version of transform.
int	planeIndex()
VkDisplaySurfaceCreateInfoKHR	planeIndex(int value)	Sets the specified value to the planeIndex field.
int	planeStackIndex()
VkDisplaySurfaceCreateInfoKHR	planeStackIndex(int value)	Sets the specified value to the planeStackIndex field.
long	pNext()
VkDisplaySurfaceCreateInfoKHR	pNext(long value)	Sets the specified value to the pNext field.
VkDisplaySurfaceCreateInfoKHR	pNext(VkDisplaySurfaceStereoCreateInfoNV value)	Prepends the specified VkDisplaySurfaceStereoCreateInfoNV value to the pNext chain.
VkDisplaySurfaceCreateInfoKHR	set(int sType, long pNext, int flags, long displayMode, int planeIndex, int planeStackIndex, int transform, float globalAlpha, int alphaMode, VkExtent2D imageExtent)	Initializes this struct with the specified values.
VkDisplaySurfaceCreateInfoKHR	set(VkDisplaySurfaceCreateInfoKHR src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	sType()
VkDisplaySurfaceCreateInfoKHR	sType(int value)	Sets the specified value to the sType field.
VkDisplaySurfaceCreateInfoKHR	sType$Default()	Sets the STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR value to the sType field.
int	transform()
VkDisplaySurfaceCreateInfoKHR	transform(int value)	Sets the specified value to the transform 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.

DISPLAYMODE

public static final int DISPLAYMODE

The struct member offsets.

PLANEINDEX

public static final int PLANEINDEX

The struct member offsets.

PLANESTACKINDEX

public static final int PLANESTACKINDEX

The struct member offsets.

TRANSFORM

public static final int TRANSFORM

The struct member offsets.

GLOBALALPHA

public static final int GLOBALALPHA

The struct member offsets.

ALPHAMODE

public static final int ALPHAMODE

The struct member offsets.

IMAGEEXTENT

public static final int IMAGEEXTENT

The struct member offsets.

Constructor Details

VkDisplaySurfaceCreateInfoKHR

public VkDisplaySurfaceCreateInfoKHR(ByteBuffer container)

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

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("VkDisplaySurfaceCreateFlagsKHR")
public int flags()

Returns:

the value of the flags field.

displayMode

@NativeType("VkDisplayModeKHR")
public long displayMode()

Returns:

the value of the displayMode field.

planeIndex

@NativeType("uint32_t")
public int planeIndex()

Returns:

the value of the planeIndex field.

planeStackIndex

@NativeType("uint32_t")
public int planeStackIndex()

Returns:

the value of the planeStackIndex field.

transform

@NativeType("VkSurfaceTransformFlagBitsKHR")
public int transform()

Returns:

the value of the transform field.

globalAlpha

public float globalAlpha()

Returns:

the value of the globalAlpha field.

alphaMode

@NativeType("VkDisplayPlaneAlphaFlagBitsKHR")
public int alphaMode()

Returns:

the value of the alphaMode field.

imageExtent

public VkExtent2D imageExtent()

Returns:

a VkExtent2D view of the imageExtent field.

sType

public VkDisplaySurfaceCreateInfoKHR sType(@NativeType("VkStructureType")
 int value)

Sets the specified value to the sType field.

sType$Default

public VkDisplaySurfaceCreateInfoKHR sType$Default()

Sets the STRUCTURE_TYPE_DISPLAY_SURFACE_CREATE_INFO_KHR value to the sType field.

pNext

public VkDisplaySurfaceCreateInfoKHR pNext(@NativeType("void const *")
 long value)

Sets the specified value to the pNext field.

pNext

public VkDisplaySurfaceCreateInfoKHR pNext(VkDisplaySurfaceStereoCreateInfoNV value)

Prepends the specified VkDisplaySurfaceStereoCreateInfoNV value to the pNext chain.

flags

public VkDisplaySurfaceCreateInfoKHR flags(@NativeType("VkDisplaySurfaceCreateFlagsKHR")
 int value)

Sets the specified value to the flags field.

displayMode

public VkDisplaySurfaceCreateInfoKHR displayMode(@NativeType("VkDisplayModeKHR")
 long value)

Sets the specified value to the displayMode field.

planeIndex

public VkDisplaySurfaceCreateInfoKHR planeIndex(@NativeType("uint32_t")
 int value)

Sets the specified value to the planeIndex field.

planeStackIndex

public VkDisplaySurfaceCreateInfoKHR planeStackIndex(@NativeType("uint32_t")
 int value)

Sets the specified value to the planeStackIndex field.

transform

public VkDisplaySurfaceCreateInfoKHR transform(@NativeType("VkSurfaceTransformFlagBitsKHR")
 int value)

Sets the specified value to the transform field.

globalAlpha

public VkDisplaySurfaceCreateInfoKHR globalAlpha(float value)

Sets the specified value to the globalAlpha field.

alphaMode

public VkDisplaySurfaceCreateInfoKHR alphaMode(@NativeType("VkDisplayPlaneAlphaFlagBitsKHR")
 int value)

Sets the specified value to the alphaMode field.

imageExtent

public VkDisplaySurfaceCreateInfoKHR imageExtent(VkExtent2D value)

Copies the specified VkExtent2D to the imageExtent field.

imageExtent

public VkDisplaySurfaceCreateInfoKHR imageExtent(Consumer<VkExtent2D> consumer)

Passes the imageExtent field to the specified Consumer.

set

public VkDisplaySurfaceCreateInfoKHR set(int sType,
 long pNext,
 int flags,
 long displayMode,
 int planeIndex,
 int planeStackIndex,
 int transform,
 float globalAlpha,
 int alphaMode,
 VkExtent2D imageExtent)

Initializes this struct with the specified values.

set

public VkDisplaySurfaceCreateInfoKHR set(VkDisplaySurfaceCreateInfoKHR src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkDisplaySurfaceCreateInfoKHR malloc()

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

calloc

public static VkDisplaySurfaceCreateInfoKHR calloc()

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

create

public static VkDisplaySurfaceCreateInfoKHR create()

Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated with BufferUtils.

create

public static VkDisplaySurfaceCreateInfoKHR create(long address)

Returns a new VkDisplaySurfaceCreateInfoKHR instance for the specified memory address.

createSafe

public static @Nullable VkDisplaySurfaceCreateInfoKHR createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkDisplaySurfaceCreateInfoKHR.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkDisplaySurfaceCreateInfoKHR.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkDisplaySurfaceCreateInfoKHR.Buffer create(int capacity)

Returns a new VkDisplaySurfaceCreateInfoKHR.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkDisplaySurfaceCreateInfoKHR.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkDisplaySurfaceCreateInfoKHR malloc(MemoryStack stack)

Returns a new VkDisplaySurfaceCreateInfoKHR instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkDisplaySurfaceCreateInfoKHR calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkDisplaySurfaceCreateInfoKHR.Buffer malloc(int capacity,
 MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkDisplaySurfaceCreateInfoKHR.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new VkDisplaySurfaceCreateInfoKHR.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().

ndisplayMode

public static long ndisplayMode(long struct)

Unsafe version of displayMode().

nplaneIndex

public static int nplaneIndex(long struct)

Unsafe version of planeIndex().

nplaneStackIndex

public static int nplaneStackIndex(long struct)

Unsafe version of planeStackIndex().

ntransform

public static int ntransform(long struct)

Unsafe version of transform().

nglobalAlpha

public static float nglobalAlpha(long struct)

Unsafe version of globalAlpha().

nalphaMode

public static int nalphaMode(long struct)

Unsafe version of alphaMode().

nimageExtent

public static VkExtent2D nimageExtent(long struct)

Unsafe version of imageExtent().

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.

ndisplayMode

public static void ndisplayMode(long struct,
 long value)

Unsafe version of displayMode.

nplaneIndex

public static void nplaneIndex(long struct,
 int value)

Unsafe version of planeIndex.

nplaneStackIndex

public static void nplaneStackIndex(long struct,
 int value)

Unsafe version of planeStackIndex.

ntransform

public static void ntransform(long struct,
 int value)

Unsafe version of transform.

nglobalAlpha

public static void nglobalAlpha(long struct,
 float value)

Unsafe version of globalAlpha.

nalphaMode

public static void nalphaMode(long struct,
 int value)

Unsafe version of alphaMode.

nimageExtent

public static void nimageExtent(long struct,
 VkExtent2D value)

Unsafe version of imageExtent.