Package org.lwjgl.vulkan
Class VkDisplayModeCreateInfoKHR
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkDisplayModeCreateInfoKHR
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkDisplayModeCreateInfoKHR extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about how a display mode should be created.
Valid Usage
sType
must beSTRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
pNext
must beNULL
flags
must be 0- The
width
andheight
members of thevisibleRegion
member ofparameters
must be greater than 0 - The
refreshRate
member ofparameters
must be greater than 0
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_DISPLAY_MODE_CREATE_INFO_KHR
pNext
– reserved for use by extensionsflags
– reserved for future use, and must be zeroparameters
– aVkDisplayModeParametersKHR
structure describing the display parameters to use in creating the new mode
Layout
struct VkDisplayModeCreateInfoKHR { VkStructureType sType; const void * pNext; VkDisplayModeCreateFlagsKHR flags;
VkDisplayModeParametersKHR
parameters; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkDisplayModeCreateInfoKHR.Buffer
An array ofVkDisplayModeCreateInfoKHR
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and Description VkDisplayModeCreateInfoKHR(java.nio.ByteBuffer container)
Creates aVkDisplayModeCreateInfoKHR
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static VkDisplayModeCreateInfoKHR
calloc()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated withmemCalloc
.static VkDisplayModeCreateInfoKHR.Buffer
calloc(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated withmemCalloc
.static VkDisplayModeCreateInfoKHR
callocStack()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayModeCreateInfoKHR.Buffer
callocStack(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkDisplayModeCreateInfoKHR.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayModeCreateInfoKHR
callocStack(MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkDisplayModeCreateInfoKHR
create()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated withBufferUtils
.static VkDisplayModeCreateInfoKHR.Buffer
create(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated withBufferUtils
.static VkDisplayModeCreateInfoKHR
create(long address)
Returns a newVkDisplayModeCreateInfoKHR
instance for the specified memory address ornull
if the address isNULL
.static VkDisplayModeCreateInfoKHR.Buffer
create(long address, int capacity)
Create aVkDisplayModeCreateInfoKHR.Buffer
instance at the specified memory.int
flags()
Returns the value of theflags
field.VkDisplayModeCreateInfoKHR
flags(int value)
Sets the specified value to theflags
field.static VkDisplayModeCreateInfoKHR
malloc()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated withmemAlloc
.static VkDisplayModeCreateInfoKHR.Buffer
malloc(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated withmemAlloc
.static VkDisplayModeCreateInfoKHR
mallocStack()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the thread-localMemoryStack
.static VkDisplayModeCreateInfoKHR.Buffer
mallocStack(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.static VkDisplayModeCreateInfoKHR.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.static VkDisplayModeCreateInfoKHR
mallocStack(MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the specifiedMemoryStack
.VkDisplayModeCreateInfoKHR
nset(long struct)
Unsafe version ofset
.VkDisplayModeParametersKHR
parameters()
Returns aVkDisplayModeParametersKHR
view of theparameters
field.VkDisplayModeCreateInfoKHR
parameters(VkDisplayModeParametersKHR value)
Copies the specifiedVkDisplayModeParametersKHR
to theparameters
field.long
pNext()
Returns the value of thepNext
field.VkDisplayModeCreateInfoKHR
pNext(long value)
Sets the specified value to thepNext
field.VkDisplayModeCreateInfoKHR
set(int sType, long pNext, int flags, VkDisplayModeParametersKHR parameters)
Initializes this struct with the specified values.VkDisplayModeCreateInfoKHR
set(VkDisplayModeCreateInfoKHR src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkDisplayModeCreateInfoKHR
sType(int value)
Sets the specified value to thesType
field.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
Constructor Detail
-
VkDisplayModeCreateInfoKHR
public VkDisplayModeCreateInfoKHR(java.nio.ByteBuffer container)
Creates aVkDisplayModeCreateInfoKHR
instance at the current position of the specifiedByteBuffer
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
-
sizeof
public int sizeof()
Description copied from class:Struct
Returns thesizeof(struct)
.
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
parameters
public VkDisplayModeParametersKHR parameters()
Returns aVkDisplayModeParametersKHR
view of theparameters
field.
-
sType
public VkDisplayModeCreateInfoKHR sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkDisplayModeCreateInfoKHR pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkDisplayModeCreateInfoKHR flags(int value)
Sets the specified value to theflags
field.
-
parameters
public VkDisplayModeCreateInfoKHR parameters(VkDisplayModeParametersKHR value)
Copies the specifiedVkDisplayModeParametersKHR
to theparameters
field.
-
set
public VkDisplayModeCreateInfoKHR set(int sType, long pNext, int flags, VkDisplayModeParametersKHR parameters)
Initializes this struct with the specified values.
-
nset
public VkDisplayModeCreateInfoKHR nset(long struct)
Unsafe version ofset
.
-
set
public VkDisplayModeCreateInfoKHR set(VkDisplayModeCreateInfoKHR src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkDisplayModeCreateInfoKHR malloc()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkDisplayModeCreateInfoKHR calloc()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkDisplayModeCreateInfoKHR create()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated withBufferUtils
.
-
create
public static VkDisplayModeCreateInfoKHR create(long address)
Returns a newVkDisplayModeCreateInfoKHR
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkDisplayModeCreateInfoKHR.Buffer malloc(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkDisplayModeCreateInfoKHR.Buffer calloc(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayModeCreateInfoKHR.Buffer create(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkDisplayModeCreateInfoKHR.Buffer create(long address, int capacity)
Create aVkDisplayModeCreateInfoKHR.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkDisplayModeCreateInfoKHR mallocStack()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkDisplayModeCreateInfoKHR callocStack()
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkDisplayModeCreateInfoKHR mallocStack(MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkDisplayModeCreateInfoKHR callocStack(MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkDisplayModeCreateInfoKHR.Buffer mallocStack(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkDisplayModeCreateInfoKHR.Buffer callocStack(int capacity)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkDisplayModeCreateInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkDisplayModeCreateInfoKHR.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkDisplayModeCreateInfoKHR.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-