org.lwjgl.vulkan.VkPipelineViewportWScalingStateCreateInfoNV Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-vulkan Show documentation
Show all versions of lwjgl-vulkan Show documentation
A new generation graphics and compute API that provides high-efficiency, cross-platform access to modern GPUs used in a wide variety of devices from PCs and consoles to mobile phones and embedded platforms.
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.vulkan;
import java.nio.*;
import org.lwjgl.*;
import org.lwjgl.system.*;
import static org.lwjgl.system.Checks.*;
import static org.lwjgl.system.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* Structure specifying parameters of a newly created pipeline viewport W scaling state.
*
* Valid Usage
*
*
* - If the multiple viewports feature is not enabled and {@code viewportWScalingEnable} is {@link VK10#VK_TRUE TRUE}, {@code viewportCount} must be 1
* - {@code viewportCount} must be between 1 and {@link VkPhysicalDeviceLimits}{@code ::maxViewports}, inclusive if {@code viewportWScalingEnable} is {@link VK10#VK_TRUE TRUE}
* - {@code viewportCount} and {@link VkPipelineViewportStateCreateInfo}{@code ::viewportCount} must be identical if {@code viewportWScalingEnable} is {@link VK10#VK_TRUE TRUE}
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link NVClipSpaceWScaling#VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_W_SCALING_STATE_CREATE_INFO_NV STRUCTURE_TYPE_PIPELINE_VIEWPORT_W_SCALING_STATE_CREATE_INFO_NV}
* - {@code viewportCount} must be greater than 0
*
*
* See Also
*
* {@link VkViewportWScalingNV}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure
* - {@code viewportWScalingEnable} – the enable for viewport W scaling
* - {@code viewportCount} – the number of viewports used by W scaling and must match the number of viewports in the pipeline if viewport W scaling is enabled.
* - {@code pViewportWScalings} – a pointer to an array of {@link VkViewportWScalingNV} structures which define the W scaling parameters for the corresponding viewport. If the viewport W scaling state is dynamic, this member is ignored. If no element of the {@code pDynamicStates} member of sname::VkPipelineViewportStateCreateInfo{@code ::pDynamicState} is {@link NVClipSpaceWScaling#VK_DYNAMIC_STATE_VIEWPORT_W_SCALING_NV DYNAMIC_STATE_VIEWPORT_W_SCALING_NV}, the {@code pViewportScalings} member of a {@link VkPipelineViewportWScalingStateCreateInfoNV} extension structure must be a pointer to an array of {@link VkPipelineViewportWScalingStateCreateInfoNV}{@code ::viewportCount} {@link VkViewportWScalingNV} structures
*
*
* Layout
*
*
* struct VkPipelineViewportWScalingStateCreateInfoNV {
* VkStructureType sType;
* const void * pNext;
* VkBool32 viewportWScalingEnable;
* uint32_t viewportCount;
* const {@link VkViewportWScalingNV VkViewportWScalingNV} * pViewportWScalings;
* }The created instance holds a strong reference to the container object.
*/
public VkPipelineViewportWScalingStateCreateInfoNV(ByteBuffer container) {
this(memAddress(container), checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return npNext(address()); }
/** Returns the value of the {@code viewportWScalingEnable} field. */
@NativeType("VkBool32")
public boolean viewportWScalingEnable() { return nviewportWScalingEnable(address()) != 0; }
/** Returns the value of the {@code viewportCount} field. */
@NativeType("uint32_t")
public int viewportCount() { return nviewportCount(address()); }
/** Returns a {@link VkViewportWScalingNV.Buffer} view of the struct array pointed to by the {@code pViewportWScalings} field. */
@NativeType("const VkViewportWScalingNV *")
public VkViewportWScalingNV.Buffer pViewportWScalings() { return npViewportWScalings(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkPipelineViewportWScalingStateCreateInfoNV sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPipelineViewportWScalingStateCreateInfoNV pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code viewportWScalingEnable} field. */
public VkPipelineViewportWScalingStateCreateInfoNV viewportWScalingEnable(@NativeType("VkBool32") boolean value) { nviewportWScalingEnable(address(), value ? 1 : 0); return this; }
/** Sets the address of the specified {@link VkViewportWScalingNV.Buffer} to the {@code pViewportWScalings} field. */
public VkPipelineViewportWScalingStateCreateInfoNV pViewportWScalings(@NativeType("const VkViewportWScalingNV *") VkViewportWScalingNV.Buffer value) { npViewportWScalings(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkPipelineViewportWScalingStateCreateInfoNV set(
int sType,
long pNext,
boolean viewportWScalingEnable,
VkViewportWScalingNV.Buffer pViewportWScalings
) {
sType(sType);
pNext(pNext);
viewportWScalingEnable(viewportWScalingEnable);
pViewportWScalings(pViewportWScalings);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkPipelineViewportWScalingStateCreateInfoNV set(VkPipelineViewportWScalingStateCreateInfoNV src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkPipelineViewportWScalingStateCreateInfoNV malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkPipelineViewportWScalingStateCreateInfoNV calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance allocated with {@link BufferUtils}. */
public static VkPipelineViewportWScalingStateCreateInfoNV create() {
return new VkPipelineViewportWScalingStateCreateInfoNV(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkPipelineViewportWScalingStateCreateInfoNV create(long address) {
return address == NULL ? null : new VkPipelineViewportWScalingStateCreateInfoNV(address, null);
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static Buffer calloc(int capacity) {
return create(nmemCalloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static Buffer create(long address, int capacity) {
return address == NULL ? null : new Buffer(address, null, -1, 0, capacity, capacity);
}
// -----------------------------------
/** Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance allocated on the thread-local {@link MemoryStack}. */
public static VkPipelineViewportWScalingStateCreateInfoNV mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkPipelineViewportWScalingStateCreateInfoNV callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkPipelineViewportWScalingStateCreateInfoNV mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkPipelineViewportWScalingStateCreateInfoNV callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkPipelineViewportWScalingStateCreateInfoNV.Buffer} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #sType}. */
public static int nsType(long struct) { return memGetInt(struct + VkPipelineViewportWScalingStateCreateInfoNV.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkPipelineViewportWScalingStateCreateInfoNV.PNEXT); }
/** Unsafe version of {@link #viewportWScalingEnable}. */
public static int nviewportWScalingEnable(long struct) { return memGetInt(struct + VkPipelineViewportWScalingStateCreateInfoNV.VIEWPORTWSCALINGENABLE); }
/** Unsafe version of {@link #viewportCount}. */
public static int nviewportCount(long struct) { return memGetInt(struct + VkPipelineViewportWScalingStateCreateInfoNV.VIEWPORTCOUNT); }
/** Unsafe version of {@link #pViewportWScalings}. */
public static VkViewportWScalingNV.Buffer npViewportWScalings(long struct) { return VkViewportWScalingNV.create(memGetAddress(struct + VkPipelineViewportWScalingStateCreateInfoNV.PVIEWPORTWSCALINGS), nviewportCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkPipelineViewportWScalingStateCreateInfoNV.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkPipelineViewportWScalingStateCreateInfoNV.PNEXT, value); }
/** Unsafe version of {@link #viewportWScalingEnable(boolean) viewportWScalingEnable}. */
public static void nviewportWScalingEnable(long struct, int value) { memPutInt(struct + VkPipelineViewportWScalingStateCreateInfoNV.VIEWPORTWSCALINGENABLE, value); }
/** Sets the specified value to the {@code viewportCount} field of the specified {@code struct}. */
public static void nviewportCount(long struct, int value) { memPutInt(struct + VkPipelineViewportWScalingStateCreateInfoNV.VIEWPORTCOUNT, value); }
/** Unsafe version of {@link #pViewportWScalings(VkViewportWScalingNV.Buffer) pViewportWScalings}. */
public static void npViewportWScalings(long struct, VkViewportWScalingNV.Buffer value) { memPutAddress(struct + VkPipelineViewportWScalingStateCreateInfoNV.PVIEWPORTWSCALINGS, value.address()); nviewportCount(struct, value.remaining()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
check(memGetAddress(struct + VkPipelineViewportWScalingStateCreateInfoNV.PVIEWPORTWSCALINGS));
}
/**
* Calls {@link #validate(long)} for each struct contained in the specified struct array.
*
* @param array the struct array to validate
* @param count the number of structs in {@code array}
*/
public static void validate(long array, int count) {
for (int i = 0; i < count; i++) {
validate(array + i * SIZEOF);
}
}
// -----------------------------------
/** An array of {@link VkPipelineViewportWScalingStateCreateInfoNV} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkPipelineViewportWScalingStateCreateInfoNV.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 {@link VkPipelineViewportWScalingStateCreateInfoNV#SIZEOF}, and its mark will be undefined.
*
* The created buffer instance holds a strong reference to the container object.
*/
public Buffer(ByteBuffer container) {
super(container, container.remaining() / SIZEOF);
}
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
super(address, container, mark, pos, lim, cap);
}
@Override
protected Buffer self() {
return this;
}
@Override
protected Buffer newBufferInstance(long address, ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkPipelineViewportWScalingStateCreateInfoNV newInstance(long address) {
return new VkPipelineViewportWScalingStateCreateInfoNV(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkPipelineViewportWScalingStateCreateInfoNV.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkPipelineViewportWScalingStateCreateInfoNV.npNext(address()); }
/** Returns the value of the {@code viewportWScalingEnable} field. */
@NativeType("VkBool32")
public boolean viewportWScalingEnable() { return VkPipelineViewportWScalingStateCreateInfoNV.nviewportWScalingEnable(address()) != 0; }
/** Returns the value of the {@code viewportCount} field. */
@NativeType("uint32_t")
public int viewportCount() { return VkPipelineViewportWScalingStateCreateInfoNV.nviewportCount(address()); }
/** Returns a {@link VkViewportWScalingNV.Buffer} view of the struct array pointed to by the {@code pViewportWScalings} field. */
@NativeType("const VkViewportWScalingNV *")
public VkViewportWScalingNV.Buffer pViewportWScalings() { return VkPipelineViewportWScalingStateCreateInfoNV.npViewportWScalings(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkPipelineViewportWScalingStateCreateInfoNV.Buffer sType(@NativeType("VkStructureType") int value) { VkPipelineViewportWScalingStateCreateInfoNV.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkPipelineViewportWScalingStateCreateInfoNV.Buffer pNext(@NativeType("const void *") long value) { VkPipelineViewportWScalingStateCreateInfoNV.npNext(address(), value); return this; }
/** Sets the specified value to the {@code viewportWScalingEnable} field. */
public VkPipelineViewportWScalingStateCreateInfoNV.Buffer viewportWScalingEnable(@NativeType("VkBool32") boolean value) { VkPipelineViewportWScalingStateCreateInfoNV.nviewportWScalingEnable(address(), value ? 1 : 0); return this; }
/** Sets the address of the specified {@link VkViewportWScalingNV.Buffer} to the {@code pViewportWScalings} field. */
public VkPipelineViewportWScalingStateCreateInfoNV.Buffer pViewportWScalings(@NativeType("const VkViewportWScalingNV *") VkViewportWScalingNV.Buffer value) { VkPipelineViewportWScalingStateCreateInfoNV.npViewportWScalings(address(), value); return this; }
}
}