org.lwjgl.vulkan.VkImportMemoryFdInfoKHR 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.MemoryUtil.*;
import static org.lwjgl.system.MemoryStack.*;
/**
* import memory created on the same physical device from a file descriptor.
*
* Description
*
* Importing memory from a file descriptor transfers ownership of the file descriptor from the application to the Vulkan implementation. The application must not perform any operations on the file descriptor after a successful import.
*
* Applications can import the same underlying memory into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance. In all cases, each import operation must create a distinct {@code VkDeviceMemory} object.
*
* Valid Usage
*
*
* - If {@code handleType} is not 0, it must be supported for import, as reported by {@link VkExternalImageFormatPropertiesKHR} or {@link VkExternalBufferPropertiesKHR}.
* - If {@code handleType} is not 0, it must be defined as a POSIX file descriptor handle.
* - If {@code handleType} is not 0, {@code fd} must be a valid handle of the type specified by {@code handleType}.
* - The memory represented by {@code fd} must have been created from a physical device and driver that is compatible with {@code device} and {@code handleType}, as described in External memory handle types compatibility.
* - {@code fd} must obey any requirements listed for {@code handleType} in external memory handle types compatibility.
*
*
* Valid Usage (Implicit)
*
*
* - {@code sType} must be {@link KHRExternalMemoryFd#VK_STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR STRUCTURE_TYPE_IMPORT_MEMORY_FD_INFO_KHR}
* - {@code pNext} must be {@code NULL}
* - If {@code handleType} is not 0, {@code handleType} must be a valid {@code VkExternalMemoryHandleTypeFlagBitsKHR} value
*
*
* Member documentation
*
*
* - {@code sType} – the type of this structure.
* - {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
* - {@code handleType} – specifies the handle type of {@code fd}.
* - {@code fd} – the external handle to import.
*
*
* Layout
*
*
* struct VkImportMemoryFdInfoKHR {
* VkStructureType sType;
* const void * pNext;
* VkExternalMemoryHandleTypeFlagBitsKHR handleType;
* int fd;
* }The created instance holds a strong reference to the container object.
*/
public VkImportMemoryFdInfoKHR(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 handleType} field. */
@NativeType("VkExternalMemoryHandleTypeFlagBitsKHR")
public int handleType() { return nhandleType(address()); }
/** Returns the value of the {@code fd} field. */
public int fd() { return nfd(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkImportMemoryFdInfoKHR sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkImportMemoryFdInfoKHR pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; }
/** Sets the specified value to the {@code handleType} field. */
public VkImportMemoryFdInfoKHR handleType(@NativeType("VkExternalMemoryHandleTypeFlagBitsKHR") int value) { nhandleType(address(), value); return this; }
/** Sets the specified value to the {@code fd} field. */
public VkImportMemoryFdInfoKHR fd(int value) { nfd(address(), value); return this; }
/** Initializes this struct with the specified values. */
public VkImportMemoryFdInfoKHR set(
int sType,
long pNext,
int handleType,
int fd
) {
sType(sType);
pNext(pNext);
handleType(handleType);
fd(fd);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public VkImportMemoryFdInfoKHR set(VkImportMemoryFdInfoKHR src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@link VkImportMemoryFdInfoKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static VkImportMemoryFdInfoKHR malloc() {
return create(nmemAllocChecked(SIZEOF));
}
/** Returns a new {@link VkImportMemoryFdInfoKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static VkImportMemoryFdInfoKHR calloc() {
return create(nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@link VkImportMemoryFdInfoKHR} instance allocated with {@link BufferUtils}. */
public static VkImportMemoryFdInfoKHR create() {
return new VkImportMemoryFdInfoKHR(BufferUtils.createByteBuffer(SIZEOF));
}
/** Returns a new {@link VkImportMemoryFdInfoKHR} instance for the specified memory address. */
public static VkImportMemoryFdInfoKHR create(long address) {
return new VkImportMemoryFdInfoKHR(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static VkImportMemoryFdInfoKHR createSafe(long address) {
return address == NULL ? null : create(address);
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkImportMemoryFdInfoKHR.Buffer malloc(int capacity) {
return create(__malloc(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static VkImportMemoryFdInfoKHR.Buffer calloc(int capacity) {
return create(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static VkImportMemoryFdInfoKHR.Buffer create(int capacity) {
return new Buffer(__create(capacity, SIZEOF));
}
/**
* Create a {@link VkImportMemoryFdInfoKHR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static VkImportMemoryFdInfoKHR.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 VkImportMemoryFdInfoKHR.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : create(address, capacity);
}
// -----------------------------------
/** Returns a new {@link VkImportMemoryFdInfoKHR} instance allocated on the thread-local {@link MemoryStack}. */
public static VkImportMemoryFdInfoKHR mallocStack() {
return mallocStack(stackGet());
}
/** Returns a new {@link VkImportMemoryFdInfoKHR} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */
public static VkImportMemoryFdInfoKHR callocStack() {
return callocStack(stackGet());
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static VkImportMemoryFdInfoKHR mallocStack(MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static VkImportMemoryFdInfoKHR callocStack(MemoryStack stack) {
return create(stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR.Buffer} instance allocated on the thread-local {@link MemoryStack}.
*
* @param capacity the buffer capacity
*/
public static VkImportMemoryFdInfoKHR.Buffer mallocStack(int capacity) {
return mallocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR.Buffer} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero.
*
* @param capacity the buffer capacity
*/
public static VkImportMemoryFdInfoKHR.Buffer callocStack(int capacity) {
return callocStack(capacity, stackGet());
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static VkImportMemoryFdInfoKHR.Buffer mallocStack(int capacity, MemoryStack stack) {
return create(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link VkImportMemoryFdInfoKHR.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 VkImportMemoryFdInfoKHR.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 + VkImportMemoryFdInfoKHR.STYPE); }
/** Unsafe version of {@link #pNext}. */
public static long npNext(long struct) { return memGetAddress(struct + VkImportMemoryFdInfoKHR.PNEXT); }
/** Unsafe version of {@link #handleType}. */
public static int nhandleType(long struct) { return memGetInt(struct + VkImportMemoryFdInfoKHR.HANDLETYPE); }
/** Unsafe version of {@link #fd}. */
public static int nfd(long struct) { return memGetInt(struct + VkImportMemoryFdInfoKHR.FD); }
/** Unsafe version of {@link #sType(int) sType}. */
public static void nsType(long struct, int value) { memPutInt(struct + VkImportMemoryFdInfoKHR.STYPE, value); }
/** Unsafe version of {@link #pNext(long) pNext}. */
public static void npNext(long struct, long value) { memPutAddress(struct + VkImportMemoryFdInfoKHR.PNEXT, value); }
/** Unsafe version of {@link #handleType(int) handleType}. */
public static void nhandleType(long struct, int value) { memPutInt(struct + VkImportMemoryFdInfoKHR.HANDLETYPE, value); }
/** Unsafe version of {@link #fd(int) fd}. */
public static void nfd(long struct, int value) { memPutInt(struct + VkImportMemoryFdInfoKHR.FD, value); }
// -----------------------------------
/** An array of {@link VkImportMemoryFdInfoKHR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
/**
* Creates a new {@link VkImportMemoryFdInfoKHR.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 VkImportMemoryFdInfoKHR#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 VkImportMemoryFdInfoKHR newInstance(long address) {
return new VkImportMemoryFdInfoKHR(address, container);
}
@Override
public int sizeof() {
return SIZEOF;
}
/** Returns the value of the {@code sType} field. */
@NativeType("VkStructureType")
public int sType() { return VkImportMemoryFdInfoKHR.nsType(address()); }
/** Returns the value of the {@code pNext} field. */
@NativeType("const void *")
public long pNext() { return VkImportMemoryFdInfoKHR.npNext(address()); }
/** Returns the value of the {@code handleType} field. */
@NativeType("VkExternalMemoryHandleTypeFlagBitsKHR")
public int handleType() { return VkImportMemoryFdInfoKHR.nhandleType(address()); }
/** Returns the value of the {@code fd} field. */
public int fd() { return VkImportMemoryFdInfoKHR.nfd(address()); }
/** Sets the specified value to the {@code sType} field. */
public VkImportMemoryFdInfoKHR.Buffer sType(@NativeType("VkStructureType") int value) { VkImportMemoryFdInfoKHR.nsType(address(), value); return this; }
/** Sets the specified value to the {@code pNext} field. */
public VkImportMemoryFdInfoKHR.Buffer pNext(@NativeType("const void *") long value) { VkImportMemoryFdInfoKHR.npNext(address(), value); return this; }
/** Sets the specified value to the {@code handleType} field. */
public VkImportMemoryFdInfoKHR.Buffer handleType(@NativeType("VkExternalMemoryHandleTypeFlagBitsKHR") int value) { VkImportMemoryFdInfoKHR.nhandleType(address(), value); return this; }
/** Sets the specified value to the {@code fd} field. */
public VkImportMemoryFdInfoKHR.Buffer fd(int value) { VkImportMemoryFdInfoKHR.nfd(address(), value); return this; }
}
}