org.lwjgl.vulkan.VkSampleLocationsInfoEXT 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 a set of sample locations.
*
* Description
*
* This structure can be used either to specify the sample locations to be used for rendering or to specify the set of sample locations an image subresource has been last rendered with for the purposes of layout transitions of depth/stencil images created with {@link EXTSampleLocations#VK_IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT IMAGE_CREATE_SAMPLE_LOCATIONS_COMPATIBLE_DEPTH_BIT_EXT}.
*
* The sample locations in {@code pSampleLocations} specify {@code sampleLocationsPerPixel} number of sample locations for each pixel in the grid of the size specified in {@code sampleLocationGridSize}. The sample location for sample i at the pixel grid location (x,y) is taken from pSampleLocations[(x + y sampleLocationGridSize.width) sampleLocationsPerPixel + i].
*
* Valid Usage
*
*
* - {@code sampleLocationsPerPixel} must be a bit value that is set in {@link VkPhysicalDeviceSampleLocationsPropertiesEXT}{@code ::sampleLocationSampleCounts}
* - {@code sampleLocationsCount} must equal
sampleLocationsPerPixel × sampleLocationGridSize.width × sampleLocationGridSize.height
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link EXTSampleLocations#VK_STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT STRUCTURE_TYPE_SAMPLE_LOCATIONS_INFO_EXT}
* - {@code pNext} must be {@code NULL}
* - {@code sampleLocationsPerPixel} must be a valid {@code VkSampleCountFlagBits} value
* - {@code pSampleLocations} must be a pointer to an array of {@code sampleLocationsCount} {@link VkSampleLocationEXT} structures
* - {@code sampleLocationsCount} must be greater than 0
*
*
* See Also
*
* {@link VkAttachmentSampleLocationsEXT}, {@link VkExtent2D}, {@link VkPipelineSampleLocationsStateCreateInfoEXT}, {@link VkSampleLocationEXT}, {@link VkSubpassSampleLocationsEXT}, {@link EXTSampleLocations#vkCmdSetSampleLocationsEXT CmdSetSampleLocationsEXT}
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code sampleLocationsPerPixel} – a {@code VkSampleCountFlagBits} specifying the number of sample locations per pixel.
* - {@code sampleLocationGridSize} – the size of the sample location grid to select custom sample locations for.
* - {@code sampleLocationsCount} – the number of sample locations in {@code pSampleLocations}.
* - {@code pSampleLocations} – an array of {@code sampleLocationsCount} {@link VkSampleLocationEXT} structures.
*
*
* Layout
*
*
* struct VkSampleLocationsInfoEXT {
* VkStructureType sType;
* const void * pNext;
* VkSampleCountFlagBits sampleLocationsPerPixel;
* {@link VkExtent2D VkExtent2D} sampleLocationGridSize;
* uint32_t sampleLocationsCount;
* const {@link VkSampleLocationEXT VkSampleLocationEXT} * pSampleLocations;
* }The created instance holds a strong reference to the container object.
*/
public VkSampleLocationsInfoEXT(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 sampleLocationsPerPixel} field. */
@NativeType("VkSampleCountFlagBits")
public int sampleLocationsPerPixel() { return nsampleLocationsPerPixel(address()); }
/** Returns a {@link VkExtent2D} view of the {@code sampleLocationGridSize} field. */
public VkExtent2D sampleLocationGridSize() { return nsampleLocationGridSize(address()); }
/** Returns the value of the {@code sampleLocationsCount} field. */
@NativeType("uint32_t")
public int sampleLocationsCount() { return nsampleLocationsCount(address()); }
/** Returns a {@link VkSampleLocationEXT.Buffer} view of the struct array pointed to by the {@code pSampleLocations} field. */
@NativeType("const VkSampleLocationEXT *")
public VkSampleLocationEXT.Buffer pSampleLocations() { return npSampleLocations(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkSampleLocationsInfoEXT sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkSampleLocationsInfoEXT pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code sampleLocationsPerPixel} field. */
public VkSampleLocationsInfoEXT sampleLocationsPerPixel(@NativeType("VkSampleCountFlagBits") int value) { nsampleLocationsPerPixel(address(), value); return this; }
/** Copies the specified {@link VkExtent2D} to the {@code sampleLocationGridSize} field. */
public VkSampleLocationsInfoEXT sampleLocationGridSize(VkExtent2D value) { nsampleLocationGridSize(address(), value); return this; }
/** Sets the address of the specified {@link VkSampleLocationEXT.Buffer} to the {@code pSampleLocations} field. */
public VkSampleLocationsInfoEXT pSampleLocations(@NativeType("const VkSampleLocationEXT *") VkSampleLocationEXT.Buffer value) { npSampleLocations(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkSampleLocationsInfoEXT set(
int sType,
long pNext,
int sampleLocationsPerPixel,
VkExtent2D sampleLocationGridSize,
VkSampleLocationEXT.Buffer pSampleLocations
) {
sType(sType);
pNext(pNext);
sampleLocationsPerPixel(sampleLocationsPerPixel);
sampleLocationGridSize(sampleLocationGridSize);
pSampleLocations(pSampleLocations);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkSampleLocationsInfoEXT set(VkSampleLocationsInfoEXT src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkSampleLocationsInfoEXT} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkSampleLocationsInfoEXT malloc() {
return create(nmemAlloc(SIZEOF));
}
/** Returns a new {@link VkSampleLocationsInfoEXT} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkSampleLocationsInfoEXT calloc() {
return create(nmemCalloc(1, SIZEOF));
}
/** Returns a new {@link VkSampleLocationsInfoEXT} instance allocated with {@link BufferUtils}. */
public static VkSampleLocationsInfoEXT create() {
return new VkSampleLocationsInfoEXT(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkSampleLocationsInfoEXT} instance for the specified memory address or {@code null} if the address is {@code NULL}. */
public static VkSampleLocationsInfoEXT create(long address) {
return address == NULL ? null : new VkSampleLocationsInfoEXT(address, null);
}
/**
* Returns a new {@link VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT} instance allocated on the thread-local {@link MemoryStack}. */
public static VkSampleLocationsInfoEXT mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkSampleLocationsInfoEXT} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkSampleLocationsInfoEXT callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkSampleLocationsInfoEXT} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkSampleLocationsInfoEXT mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkSampleLocationsInfoEXT} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkSampleLocationsInfoEXT callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT.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 + VkSampleLocationsInfoEXT.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkSampleLocationsInfoEXT.PNEXT); }
/** Unsafe version of {@link #sampleLocationsPerPixel}. */
public static int nsampleLocationsPerPixel(long struct) { return memGetInt(struct + VkSampleLocationsInfoEXT.SAMPLELOCATIONSPERPIXEL); }
/** Unsafe version of {@link #sampleLocationGridSize}. */
public static VkExtent2D nsampleLocationGridSize(long struct) { return VkExtent2D.create(struct + VkSampleLocationsInfoEXT.SAMPLELOCATIONGRIDSIZE); }
/** Unsafe version of {@link #sampleLocationsCount}. */
public static int nsampleLocationsCount(long struct) { return memGetInt(struct + VkSampleLocationsInfoEXT.SAMPLELOCATIONSCOUNT); }
/** Unsafe version of {@link #pSampleLocations}. */
public static VkSampleLocationEXT.Buffer npSampleLocations(long struct) { return VkSampleLocationEXT.create(memGetAddress(struct + VkSampleLocationsInfoEXT.PSAMPLELOCATIONS), nsampleLocationsCount(struct)); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkSampleLocationsInfoEXT.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkSampleLocationsInfoEXT.PNEXT, value); }
/** Unsafe version of {@link #sampleLocationsPerPixel(int) sampleLocationsPerPixel}. */
public static void nsampleLocationsPerPixel(long struct, int value) { memPutInt(struct + VkSampleLocationsInfoEXT.SAMPLELOCATIONSPERPIXEL, value); }
/** Unsafe version of {@link #sampleLocationGridSize(VkExtent2D) sampleLocationGridSize}. */
public static void nsampleLocationGridSize(long struct, VkExtent2D value) { memCopy(value.address(), struct + VkSampleLocationsInfoEXT.SAMPLELOCATIONGRIDSIZE, VkExtent2D.SIZEOF); }
/** Sets the specified value to the {@code sampleLocationsCount} field of the specified {@code struct}. */
public static void nsampleLocationsCount(long struct, int value) { memPutInt(struct + VkSampleLocationsInfoEXT.SAMPLELOCATIONSCOUNT, value); }
/** Unsafe version of {@link #pSampleLocations(VkSampleLocationEXT.Buffer) pSampleLocations}. */
public static void npSampleLocations(long struct, VkSampleLocationEXT.Buffer value) { memPutAddress(struct + VkSampleLocationsInfoEXT.PSAMPLELOCATIONS, value.address()); nsampleLocationsCount(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 + VkSampleLocationsInfoEXT.PSAMPLELOCATIONS));
}
/**
* 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 VkSampleLocationsInfoEXT} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkSampleLocationsInfoEXT.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 VkSampleLocationsInfoEXT#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 VkSampleLocationsInfoEXT newInstance(long address) {
return new VkSampleLocationsInfoEXT(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkSampleLocationsInfoEXT.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkSampleLocationsInfoEXT.npNext(address()); }
/** Returns the value of the {@code sampleLocationsPerPixel} field. */
@NativeType("VkSampleCountFlagBits")
public int sampleLocationsPerPixel() { return VkSampleLocationsInfoEXT.nsampleLocationsPerPixel(address()); }
/** Returns a {@link VkExtent2D} view of the {@code sampleLocationGridSize} field. */
public VkExtent2D sampleLocationGridSize() { return VkSampleLocationsInfoEXT.nsampleLocationGridSize(address()); }
/** Returns the value of the {@code sampleLocationsCount} field. */
@NativeType("uint32_t")
public int sampleLocationsCount() { return VkSampleLocationsInfoEXT.nsampleLocationsCount(address()); }
/** Returns a {@link VkSampleLocationEXT.Buffer} view of the struct array pointed to by the {@code pSampleLocations} field. */
@NativeType("const VkSampleLocationEXT *")
public VkSampleLocationEXT.Buffer pSampleLocations() { return VkSampleLocationsInfoEXT.npSampleLocations(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkSampleLocationsInfoEXT.Buffer sType(@NativeType("VkStructureType") int value) { VkSampleLocationsInfoEXT.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkSampleLocationsInfoEXT.Buffer pNext(@NativeType("const void *") long value) { VkSampleLocationsInfoEXT.npNext(address(), value); return this; }
/** Sets the specified value to the {@code sampleLocationsPerPixel} field. */
public VkSampleLocationsInfoEXT.Buffer sampleLocationsPerPixel(@NativeType("VkSampleCountFlagBits") int value) { VkSampleLocationsInfoEXT.nsampleLocationsPerPixel(address(), value); return this; }
/** Copies the specified {@link VkExtent2D} to the {@code sampleLocationGridSize} field. */
public VkSampleLocationsInfoEXT.Buffer sampleLocationGridSize(VkExtent2D value) { VkSampleLocationsInfoEXT.nsampleLocationGridSize(address(), value); return this; }
/** Sets the address of the specified {@link VkSampleLocationEXT.Buffer} to the {@code pSampleLocations} field. */
public VkSampleLocationsInfoEXT.Buffer pSampleLocations(@NativeType("const VkSampleLocationEXT *") VkSampleLocationEXT.Buffer value) { VkSampleLocationsInfoEXT.npSampleLocations(address(), value); return this; }
}
}