org.lwjgl.vulkan.VkSpecializationInfo 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 javax.annotation.*;
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 specialization info.
*
* Description
*
* {@code pMapEntries} points to a structure of type {@link VkSpecializationMapEntry}.
*
* Valid Usage
*
*
* - The {@code offset} member of each element of {@code pMapEntries} must be less than {@code dataSize}
* - The {@code size} member of each element of {@code pMapEntries} must be less than or equal to {@code dataSize} minus {@code offset}
* - If {@code mapEntryCount} is not 0, {@code pMapEntries} must be a valid pointer to an array of {@code mapEntryCount} valid {@link VkSpecializationMapEntry} structures
*
*
* Valid Usage (Implicit)
*
*
* - If {@code dataSize} is not 0, {@code pData} must be a valid pointer to an array of {@code dataSize} bytes
*
*
* See Also
*
* {@link VkPipelineShaderStageCreateInfo}, {@link VkSpecializationMapEntry}
*
* Member documentation
*
*
* - {@code mapEntryCount} – the number of entries in the {@code pMapEntries} array.
* - {@code pMapEntries} – a pointer to an array of {@link VkSpecializationMapEntry} which maps constant IDs to offsets in {@code pData}.
* - {@code dataSize} – the byte size of the {@code pData} buffer.
* - {@code pData} – contains the actual constant values to specialize with.
*
*
* Layout
*
*
* struct VkSpecializationInfo {
* uint32_t mapEntryCount;
* const {@link VkSpecializationMapEntry VkSpecializationMapEntry} * pMapEntries;
* size_t dataSize;
* const void * pData;
* }The created instance holds a strong reference to the container object.
*/
public VkSpecializationInfo(ByteBuffer container) {
this(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Returns the value of the {@code mapEntryCount} field. */
@NativeType("uint32_t")
public int mapEntryCount() { return nmapEntryCount(address()); }
/** Returns a {@link VkSpecializationMapEntry.Buffer} view of the struct array pointed to by the {@code pMapEntries} field. */
@Nullable
@NativeType("const VkSpecializationMapEntry *")
public VkSpecializationMapEntry.Buffer pMapEntries() { return npMapEntries(address()); }
/** Returns the value of the {@code dataSize} field. */
@NativeType("size_t")
public long dataSize() { return ndataSize(address()); }
/** Returns a {@link ByteBuffer} view of the data pointed to by the {@code pData} field. */
@Nullable
@NativeType("const void *")
public ByteBuffer pData() { return npData(address()); }
/** Sets the address of the specified {@link VkSpecializationMapEntry.Buffer} to the {@code pMapEntries} field. */
public VkSpecializationInfo pMapEntries(@Nullable @NativeType("const VkSpecializationMapEntry *") VkSpecializationMapEntry.Buffer value) { npMapEntries(address(), value); return this; }
/** Sets the address of the specified {@link ByteBuffer} to the {@code pData} field. */
public VkSpecializationInfo pData(@Nullable @NativeType("const void *") ByteBuffer value) { npData(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkSpecializationInfo set(
VkSpecializationMapEntry.Buffer pMapEntries,
ByteBuffer pData
) {
pMapEntries(pMapEntries);
pData(pData);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkSpecializationInfo set(VkSpecializationInfo src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkSpecializationInfo} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkSpecializationInfo malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkSpecializationInfo} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkSpecializationInfo calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkSpecializationInfo} instance allocated with {@link BufferUtils}. */
public static VkSpecializationInfo create() {
return new VkSpecializationInfo(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkSpecializationInfo} instance for the specified memory address. */
public static VkSpecializationInfo create(long address) {
return new VkSpecializationInfo(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkSpecializationInfo createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkSpecializationInfo.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkSpecializationInfo.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSpecializationInfo.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkSpecializationInfo.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkSpecializationInfo.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkSpecializationInfo.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkSpecializationInfo.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkSpecializationInfo.Buffer create(long address, int capacity) {
return new Buffer(address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkSpecializationInfo.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkSpecializationInfo} instance allocated on the thread-local {@link MemoryStack}. */
public static VkSpecializationInfo mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkSpecializationInfo} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkSpecializationInfo callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkSpecializationInfo} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkSpecializationInfo mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkSpecializationInfo} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkSpecializationInfo callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkSpecializationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkSpecializationInfo.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSpecializationInfo.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkSpecializationInfo.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkSpecializationInfo.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkSpecializationInfo.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkSpecializationInfo.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 VkSpecializationInfo.Buffer callocStack(int capacity, MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #mapEntryCount}. */
public static int nmapEntryCount(long struct) { return memGetInt(struct + VkSpecializationInfo.MAPENTRYCOUNT); }
/** Unsafe version of {@link #pMapEntries}. */
@Nullable public static VkSpecializationMapEntry.Buffer npMapEntries(long struct) { return VkSpecializationMapEntry.createSafe(memGetAddress(struct + VkSpecializationInfo.PMAPENTRIES), nmapEntryCount(struct)); }
/** Unsafe version of {@link #dataSize}. */
public static long ndataSize(long struct) { return memGetAddress(struct + VkSpecializationInfo.DATASIZE); }
/** Unsafe version of {@link #pData() pData}. */
@Nullable public static ByteBuffer npData(long struct) { return memByteBufferSafe(memGetAddress(struct + VkSpecializationInfo.PDATA), (int)ndataSize(struct)); }
/** Sets the specified value to the {@code mapEntryCount} field of the specified {@code struct}. */
public static void nmapEntryCount(long struct, int value) { memPutInt(struct + VkSpecializationInfo.MAPENTRYCOUNT, value); }
/** Unsafe version of {@link #pMapEntries(VkSpecializationMapEntry.Buffer) pMapEntries}. */
public static void npMapEntries(long struct, @Nullable VkSpecializationMapEntry.Buffer value) { memPutAddress(struct + VkSpecializationInfo.PMAPENTRIES, memAddressSafe(value)); nmapEntryCount(struct, value == null ? 0 : value.remaining()); }
/** Sets the specified value to the {@code dataSize} field of the specified {@code struct}. */
public static void ndataSize(long struct, long value) { memPutAddress(struct + VkSpecializationInfo.DATASIZE, value); }
/** Unsafe version of {@link #pData(ByteBuffer) pData}. */
public static void npData(long struct, @Nullable ByteBuffer value) { memPutAddress(struct + VkSpecializationInfo.PDATA, memAddressSafe(value)); ndataSize(struct, value == null ? 0 : value.remaining()); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
if (nmapEntryCount(struct) != 0) {
check(memGetAddress(struct + VkSpecializationInfo.PMAPENTRIES));
}
if (ndataSize(struct) != 0) {
check(memGetAddress(struct + VkSpecializationInfo.PDATA));
}
}
/**
* 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 VkSpecializationInfo} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkSpecializationInfo.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 VkSpecializationInfo#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);
}
public Buffer(long address, int cap) {
super(address, null, -1, 0, cap, cap);
}
Buffer(long address, @Nullable 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, @Nullable ByteBuffer container, int mark, int pos, int lim, int cap) {
return new Buffer(address, container, mark, pos, lim, cap);
}
@Override
protected VkSpecializationInfo newInstance(long address) {
return new VkSpecializationInfo(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code mapEntryCount} field. */
@NativeType("uint32_t")
public int mapEntryCount() { return VkSpecializationInfo.nmapEntryCount(address()); }
/** Returns a {@link VkSpecializationMapEntry.Buffer} view of the struct array pointed to by the {@code pMapEntries} field. */
@Nullable
@NativeType("const VkSpecializationMapEntry *")
public VkSpecializationMapEntry.Buffer pMapEntries() { return VkSpecializationInfo.npMapEntries(address()); }
/** Returns the value of the {@code dataSize} field. */
@NativeType("size_t")
public long dataSize() { return VkSpecializationInfo.ndataSize(address()); }
/** Returns a {@link ByteBuffer} view of the data pointed to by the {@code pData} field. */
@Nullable
@NativeType("const void *")
public ByteBuffer pData() { return VkSpecializationInfo.npData(address()); }
/** Sets the address of the specified {@link VkSpecializationMapEntry.Buffer} to the {@code pMapEntries} field. */
public VkSpecializationInfo.Buffer pMapEntries(@Nullable @NativeType("const VkSpecializationMapEntry *") VkSpecializationMapEntry.Buffer value) { VkSpecializationInfo.npMapEntries(address(), value); return this; }
/** Sets the address of the specified {@link ByteBuffer} to the {@code pData} field. */
public VkSpecializationInfo.Buffer pData(@Nullable @NativeType("const void *") ByteBuffer value) { VkSpecializationInfo.npData(address(), value); return this; }
}
}