Package org.lwjgl.vulkan
Class VkPipelineViewportStateCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineViewportStateCreateInfo
-
- All Implemented Interfaces:
- java.lang.AutoCloseable, NativeResource, Pointer
public class VkPipelineViewportStateCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about viewports as part of graphics pipeline creation.
Valid Usage
sType
must beSTRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO
pNext
must beNULL
flags
must be 0viewportCount
must be greater than 0scissorCount
must be greater than 0- If the multiple viewports feature is not enabled,
viewportCount
must be 1 - If the multiple viewports feature is not enabled,
scissorCount
must be 1 viewportCount
must be between 1 andVkPhysicalDeviceLimits
::maxViewports
, inclusivescissorCount
must be between 1 andVkPhysicalDeviceLimits
::maxViewports
, inclusivescissorCount
andviewportCount
must be identical
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO
pNext
– reserved for use by extensionsflags
– reserved for future useviewportCount
– the number of viewports used by the pipelinepViewports
– a pointer to an array ofVkViewport
structs, defining the viewport transforms. If the viewport state is dynamic, this member is ignored.scissorCount
– the number of scissors and must match the number of viewportspScissors
– a pointer to an array ofVkRect2D
structs which define the rectangular bounds of the scissor for the corresponding viewport. If the scissor state is dynamic, this member is ignored.
Layout
struct VkPipelineViewportStateCreateInfo { VkStructureType sType; const void * pNext; VkPipelineViewportStateCreateFlags flags; uint32_t viewportCount; const VkViewport * pViewports; uint32_t scissorCount; const VkRect2D * pScissors; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class and Description static class
VkPipelineViewportStateCreateInfo.Buffer
An array ofVkPipelineViewportStateCreateInfo
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 VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineViewportStateCreateInfo
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 VkPipelineViewportStateCreateInfo
calloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemCalloc
.static VkPipelineViewportStateCreateInfo.Buffer
calloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemCalloc
.static VkPipelineViewportStateCreateInfo
callocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo.Buffer
callocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo
callocStack(MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineViewportStateCreateInfo
create()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withBufferUtils
.static VkPipelineViewportStateCreateInfo.Buffer
create(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withBufferUtils
.static VkPipelineViewportStateCreateInfo
create(long address)
Returns a newVkPipelineViewportStateCreateInfo
instance for the specified memory address ornull
if the address isNULL
.static VkPipelineViewportStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineViewportStateCreateInfo.Buffer
instance at the specified memory.int
flags()
Returns the value of theflags
field.VkPipelineViewportStateCreateInfo
flags(int value)
Sets the specified value to theflags
field.static VkPipelineViewportStateCreateInfo
malloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemAlloc
.static VkPipelineViewportStateCreateInfo.Buffer
malloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemAlloc
.static VkPipelineViewportStateCreateInfo
mallocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportStateCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineViewportStateCreateInfo.Buffer
mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineViewportStateCreateInfo
mallocStack(MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
.VkPipelineViewportStateCreateInfo
nset(long struct)
Unsafe version ofset
.long
pNext()
Returns the value of thepNext
field.VkPipelineViewportStateCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.VkRect2D.Buffer
pScissors()
Returns aVkRect2D.Buffer
view of the struct array pointed to by thepScissors
field.VkPipelineViewportStateCreateInfo
pScissors(VkRect2D.Buffer value)
Sets the address of the specifiedVkRect2D.Buffer
to thepScissors
field.VkViewport.Buffer
pViewports()
Returns aVkViewport.Buffer
view of the struct array pointed to by thepViewports
field.VkPipelineViewportStateCreateInfo
pViewports(VkViewport.Buffer value)
Sets the address of the specifiedVkViewport.Buffer
to thepViewports
field.int
scissorCount()
Returns the value of thescissorCount
field.VkPipelineViewportStateCreateInfo
scissorCount(int value)
Sets the specified value to thescissorCount
field.VkPipelineViewportStateCreateInfo
set(int sType, long pNext, int flags, int viewportCount, VkViewport.Buffer pViewports, int scissorCount, VkRect2D.Buffer pScissors)
Initializes this struct with the specified values.VkPipelineViewportStateCreateInfo
set(VkPipelineViewportStateCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
Returns thesizeof(struct)
.int
sType()
Returns the value of thesType
field.VkPipelineViewportStateCreateInfo
sType(int value)
Sets the specified value to thesType
field.int
viewportCount()
Returns the value of theviewportCount
field.VkPipelineViewportStateCreateInfo
viewportCount(int value)
Sets the specified value to theviewportCount
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
-
VkPipelineViewportStateCreateInfo
public VkPipelineViewportStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineViewportStateCreateInfo
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.
-
viewportCount
public int viewportCount()
Returns the value of theviewportCount
field.
-
pViewports
public VkViewport.Buffer pViewports()
Returns aVkViewport.Buffer
view of the struct array pointed to by thepViewports
field.
-
scissorCount
public int scissorCount()
Returns the value of thescissorCount
field.
-
pScissors
public VkRect2D.Buffer pScissors()
Returns aVkRect2D.Buffer
view of the struct array pointed to by thepScissors
field.
-
sType
public VkPipelineViewportStateCreateInfo sType(int value)
Sets the specified value to thesType
field.
-
pNext
public VkPipelineViewportStateCreateInfo pNext(long value)
Sets the specified value to thepNext
field.
-
flags
public VkPipelineViewportStateCreateInfo flags(int value)
Sets the specified value to theflags
field.
-
viewportCount
public VkPipelineViewportStateCreateInfo viewportCount(int value)
Sets the specified value to theviewportCount
field.
-
pViewports
public VkPipelineViewportStateCreateInfo pViewports(VkViewport.Buffer value)
Sets the address of the specifiedVkViewport.Buffer
to thepViewports
field.
-
scissorCount
public VkPipelineViewportStateCreateInfo scissorCount(int value)
Sets the specified value to thescissorCount
field.
-
pScissors
public VkPipelineViewportStateCreateInfo pScissors(VkRect2D.Buffer value)
Sets the address of the specifiedVkRect2D.Buffer
to thepScissors
field.
-
set
public VkPipelineViewportStateCreateInfo set(int sType, long pNext, int flags, int viewportCount, VkViewport.Buffer pViewports, int scissorCount, VkRect2D.Buffer pScissors)
Initializes this struct with the specified values.
-
nset
public VkPipelineViewportStateCreateInfo nset(long struct)
Unsafe version ofset
.
-
set
public VkPipelineViewportStateCreateInfo set(VkPipelineViewportStateCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineViewportStateCreateInfo malloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineViewportStateCreateInfo calloc()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineViewportStateCreateInfo create()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkPipelineViewportStateCreateInfo create(long address)
Returns a newVkPipelineViewportStateCreateInfo
instance for the specified memory address ornull
if the address isNULL
.
-
malloc
public static VkPipelineViewportStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineViewportStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineViewportStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineViewportStateCreateInfo.Buffer
instance at the specified memory.- Parameters:
address
- the memory addresscapacity
- the buffer capacity
-
mallocStack
public static VkPipelineViewportStateCreateInfo mallocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineViewportStateCreateInfo callocStack()
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineViewportStateCreateInfo mallocStack(MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineViewportStateCreateInfo callocStack(MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
mallocStack
public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacity
-
mallocStack
public static VkPipelineViewportStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
callocStack
public static VkPipelineViewportStateCreateInfo.Buffer callocStack(int capacity, MemoryStack stack)
Returns a newVkPipelineViewportStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocatecapacity
- the buffer capacity
-
-