All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.lwjgl.vulkan.VkImportSemaphoreWin32HandleInfoKHR Maven / Gradle / Ivy

Go to download

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.

There is a newer version: 3.3.4
Show newest version
/*
 * 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.*;

import org.lwjgl.system.windows.*;

/**
 * Structure specifying Windows handle to import to a semaphore.
 * 
 * 
Description
* *

The handle types supported by {@code handleType} are:

* *
Handle Types Supported by VkImportSemaphoreWin32HandleInfoKHR
* * * * * * * * *
Handle TypeTransferencePermanence Supported
{@link KHRExternalSemaphoreCapabilities#VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR}ReferenceTemporary,Permanent
{@link KHRExternalSemaphoreCapabilities#VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_KHR}ReferenceTemporary,Permanent
{@link KHRExternalSemaphoreCapabilities#VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT_KHR EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT_KHR}ReferenceTemporary,Permanent
* *
Valid Usage
* *
    *
  • {@code handleType} must be a value included in the Handle Types Supported by VkImportSemaphoreWin32HandleInfoKHR table.
  • *
  • If {@code handleType} is not {@link KHRExternalSemaphoreCapabilities#VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR EXTERNAL_SEMAPHORE_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR} or {@link KHRExternalSemaphoreCapabilities#VK_EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT_KHR EXTERNAL_SEMAPHORE_HANDLE_TYPE_D3D12_FENCE_BIT_KHR}, {@code name} must be {@code NULL}.
  • *
  • If {@code handleType} is not 0 and {@code handle} is {@code NULL}, {@code name} must name a valid synchronization primitive of the type specified by {@code handleType}.
  • *
  • If {@code handleType} is not 0 and {@code name} is {@code NULL}, {@code handle} must be a valid handle of the type specified by {@code handleType}.
  • *
  • If {@code handle} is not {@code NULL}, {@code name} must be {@code NULL}.
  • *
  • If {@code handle} is not {@code NULL}, it must obey any requirements listed for {@code handleType} in external semaphore handle types compatibility.
  • *
  • If {@code name} is not {@code NULL}, it must obey any requirements listed for {@code handleType} in external semaphore handle types compatibility.
  • *
* *
Valid Usage (Implicit)
* *
    *
  • {@code sType} must be {@link KHRExternalSemaphoreWin32#VK_STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR STRUCTURE_TYPE_IMPORT_SEMAPHORE_WIN32_HANDLE_INFO_KHR}
  • *
  • {@code pNext} must be {@code NULL}
  • *
  • {@code semaphore} must be a valid {@code VkSemaphore} handle
  • *
  • {@code flags} must be a valid combination of {@code VkSemaphoreImportFlagBitsKHR} values
  • *
  • If {@code handleType} is not 0, {@code handleType} must be a valid {@code VkExternalSemaphoreHandleTypeFlagBitsKHR} value
  • *
* *
Host Synchronization
* *
    *
  • Host access to {@code semaphore} must be externally synchronized
  • *
* *
See Also
* *

{@link KHRExternalSemaphoreWin32#vkImportSemaphoreWin32HandleKHR ImportSemaphoreWin32HandleKHR}

* *

Member documentation

* *
    *
  • {@code sType} – the type of this structure.
  • *
  • {@code pNext} – {@code NULL} or a pointer to an extension-specific structure.
  • *
  • {@code semaphore} – the semaphore into which the payload will be imported.
  • *
  • {@code flags} – a bitmask of {@code VkSemaphoreImportFlagBitsKHR} specifying additional parameters for the semaphore payload import operation.
  • *
  • {@code handleType} – specifies the type of {@code handle}.
  • *
  • {@code handle} – the external handle to import, or {@code NULL}.
  • *
  • {@code name} – a NULL-terminated UTF-16 string naming the underlying synchronization primitive to import, or {@code NULL}.
  • *
* *

Layout

* *
 * struct VkImportSemaphoreWin32HandleInfoKHR {
 *     VkStructureType sType;
 *     const void * pNext;
 *     VkSemaphore semaphore;
 *     VkSemaphoreImportFlagsKHR flags;
 *     VkExternalSemaphoreHandleTypeFlagBitsKHR handleType;
 *     HANDLE handle;
 *     LPCWSTR name;
 * }
*/ public class VkImportSemaphoreWin32HandleInfoKHR extends Struct implements NativeResource { /** The struct size in bytes. */ public static final int SIZEOF; public static final int ALIGNOF; /** The struct member offsets. */ public static final int STYPE, PNEXT, SEMAPHORE, FLAGS, HANDLETYPE, HANDLE, NAME; static { Layout layout = __struct( __member(4), __member(POINTER_SIZE), __member(8), __member(4), __member(4), __member(POINTER_SIZE), __member(POINTER_SIZE) ); SIZEOF = layout.getSize(); ALIGNOF = layout.getAlignment(); STYPE = layout.offsetof(0); PNEXT = layout.offsetof(1); SEMAPHORE = layout.offsetof(2); FLAGS = layout.offsetof(3); HANDLETYPE = layout.offsetof(4); HANDLE = layout.offsetof(5); NAME = layout.offsetof(6); } VkImportSemaphoreWin32HandleInfoKHR(long address, ByteBuffer container) { super(address, container); } /** * Creates a {@link VkImportSemaphoreWin32HandleInfoKHR} instance at the current position of the specified {@link ByteBuffer} 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.

*/ public VkImportSemaphoreWin32HandleInfoKHR(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 semaphore} field. */ @NativeType("VkSemaphore") public long semaphore() { return nsemaphore(address()); } /** Returns the value of the {@code flags} field. */ @NativeType("VkSemaphoreImportFlagsKHR") public int flags() { return nflags(address()); } /** Returns the value of the {@code handleType} field. */ @NativeType("VkExternalSemaphoreHandleTypeFlagBitsKHR") public int handleType() { return nhandleType(address()); } /** Returns the value of the {@code handle} field. */ @NativeType("HANDLE") public long handle() { return nhandle(address()); } /** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code name} field. */ @NativeType("LPCWSTR") public ByteBuffer name() { return nname(address()); } /** Decodes the null-terminated string pointed to by the {@code name} field. */ @NativeType("LPCWSTR") public String nameString() { return nnameString(address()); } /** Sets the specified value to the {@code sType} field. */ public VkImportSemaphoreWin32HandleInfoKHR sType(@NativeType("VkStructureType") int value) { nsType(address(), value); return this; } /** Sets the specified value to the {@code pNext} field. */ public VkImportSemaphoreWin32HandleInfoKHR pNext(@NativeType("const void *") long value) { npNext(address(), value); return this; } /** Sets the specified value to the {@code semaphore} field. */ public VkImportSemaphoreWin32HandleInfoKHR semaphore(@NativeType("VkSemaphore") long value) { nsemaphore(address(), value); return this; } /** Sets the specified value to the {@code flags} field. */ public VkImportSemaphoreWin32HandleInfoKHR flags(@NativeType("VkSemaphoreImportFlagsKHR") int value) { nflags(address(), value); return this; } /** Sets the specified value to the {@code handleType} field. */ public VkImportSemaphoreWin32HandleInfoKHR handleType(@NativeType("VkExternalSemaphoreHandleTypeFlagBitsKHR") int value) { nhandleType(address(), value); return this; } /** Sets the specified value to the {@code handle} field. */ public VkImportSemaphoreWin32HandleInfoKHR handle(@NativeType("HANDLE") long value) { nhandle(address(), value); return this; } /** Sets the address of the specified encoded string to the {@code name} field. */ public VkImportSemaphoreWin32HandleInfoKHR name(@NativeType("LPCWSTR") ByteBuffer value) { nname(address(), value); return this; } /** Initializes this struct with the specified values. */ public VkImportSemaphoreWin32HandleInfoKHR set( int sType, long pNext, long semaphore, int flags, int handleType, long handle, ByteBuffer name ) { sType(sType); pNext(pNext); semaphore(semaphore); flags(flags); handleType(handleType); handle(handle); name(name); return this; } /** * Copies the specified struct data to this struct. * * @param src the source struct * * @return this struct */ public VkImportSemaphoreWin32HandleInfoKHR set(VkImportSemaphoreWin32HandleInfoKHR src) { memCopy(src.address(), address(), SIZEOF); return this; } // ----------------------------------- /** Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */ public static VkImportSemaphoreWin32HandleInfoKHR malloc() { return create(nmemAlloc(SIZEOF)); } /** Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */ public static VkImportSemaphoreWin32HandleInfoKHR calloc() { return create(nmemCalloc(1, SIZEOF)); } /** Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR} instance allocated with {@link BufferUtils}. */ public static VkImportSemaphoreWin32HandleInfoKHR create() { return new VkImportSemaphoreWin32HandleInfoKHR(BufferUtils.createByteBuffer(SIZEOF)); } /** Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR} instance for the specified memory address or {@code null} if the address is {@code NULL}. */ public static VkImportSemaphoreWin32HandleInfoKHR create(long address) { return address == NULL ? null : new VkImportSemaphoreWin32HandleInfoKHR(address, null); } /** * Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR} instance allocated on the thread-local {@link MemoryStack}. */ public static VkImportSemaphoreWin32HandleInfoKHR mallocStack() { return mallocStack(stackGet()); } /** Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR} instance allocated on the thread-local {@link MemoryStack} and initializes all its bits to zero. */ public static VkImportSemaphoreWin32HandleInfoKHR callocStack() { return callocStack(stackGet()); } /** * Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR} instance allocated on the specified {@link MemoryStack}. * * @param stack the stack from which to allocate */ public static VkImportSemaphoreWin32HandleInfoKHR mallocStack(MemoryStack stack) { return create(stack.nmalloc(ALIGNOF, SIZEOF)); } /** * Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero. * * @param stack the stack from which to allocate */ public static VkImportSemaphoreWin32HandleInfoKHR callocStack(MemoryStack stack) { return create(stack.ncalloc(ALIGNOF, 1, SIZEOF)); } /** * Returns a new {@link VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR.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 + VkImportSemaphoreWin32HandleInfoKHR.STYPE); } /** Unsafe version of {@link #pNext}. */ public static long npNext(long struct) { return memGetAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.PNEXT); } /** Unsafe version of {@link #semaphore}. */ public static long nsemaphore(long struct) { return memGetLong(struct + VkImportSemaphoreWin32HandleInfoKHR.SEMAPHORE); } /** Unsafe version of {@link #flags}. */ public static int nflags(long struct) { return memGetInt(struct + VkImportSemaphoreWin32HandleInfoKHR.FLAGS); } /** Unsafe version of {@link #handleType}. */ public static int nhandleType(long struct) { return memGetInt(struct + VkImportSemaphoreWin32HandleInfoKHR.HANDLETYPE); } /** Unsafe version of {@link #handle}. */ public static long nhandle(long struct) { return memGetAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.HANDLE); } /** Unsafe version of {@link #name}. */ public static ByteBuffer nname(long struct) { return memByteBufferNT2(memGetAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.NAME)); } /** Unsafe version of {@link #nameString}. */ public static String nnameString(long struct) { return memUTF16(memGetAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.NAME)); } /** Unsafe version of {@link #sType(int) sType}. */ public static void nsType(long struct, int value) { memPutInt(struct + VkImportSemaphoreWin32HandleInfoKHR.STYPE, value); } /** Unsafe version of {@link #pNext(long) pNext}. */ public static void npNext(long struct, long value) { memPutAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.PNEXT, value); } /** Unsafe version of {@link #semaphore(long) semaphore}. */ public static void nsemaphore(long struct, long value) { memPutLong(struct + VkImportSemaphoreWin32HandleInfoKHR.SEMAPHORE, value); } /** Unsafe version of {@link #flags(int) flags}. */ public static void nflags(long struct, int value) { memPutInt(struct + VkImportSemaphoreWin32HandleInfoKHR.FLAGS, value); } /** Unsafe version of {@link #handleType(int) handleType}. */ public static void nhandleType(long struct, int value) { memPutInt(struct + VkImportSemaphoreWin32HandleInfoKHR.HANDLETYPE, value); } /** Unsafe version of {@link #handle(long) handle}. */ public static void nhandle(long struct, long value) { memPutAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.HANDLE, check(value)); } /** Unsafe version of {@link #name(ByteBuffer) name}. */ public static void nname(long struct, ByteBuffer value) { if (CHECKS) { checkNT2Safe(value); } memPutAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.NAME, memAddress(value)); } /** * Validates pointer members that should not be {@code NULL}. * * @param struct the struct to validate */ public static void validate(long struct) { check(memGetAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.HANDLE)); check(memGetAddress(struct + VkImportSemaphoreWin32HandleInfoKHR.NAME)); } /** * 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 VkImportSemaphoreWin32HandleInfoKHR} structs. */ public static class Buffer extends StructBuffer implements NativeResource { /** * Creates a new {@link VkImportSemaphoreWin32HandleInfoKHR.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 VkImportSemaphoreWin32HandleInfoKHR#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 VkImportSemaphoreWin32HandleInfoKHR newInstance(long address) { return new VkImportSemaphoreWin32HandleInfoKHR(address, container); } @Override public int sizeof() { return SIZEOF; } /** Returns the value of the {@code sType} field. */ @NativeType("VkStructureType") public int sType() { return VkImportSemaphoreWin32HandleInfoKHR.nsType(address()); } /** Returns the value of the {@code pNext} field. */ @NativeType("const void *") public long pNext() { return VkImportSemaphoreWin32HandleInfoKHR.npNext(address()); } /** Returns the value of the {@code semaphore} field. */ @NativeType("VkSemaphore") public long semaphore() { return VkImportSemaphoreWin32HandleInfoKHR.nsemaphore(address()); } /** Returns the value of the {@code flags} field. */ @NativeType("VkSemaphoreImportFlagsKHR") public int flags() { return VkImportSemaphoreWin32HandleInfoKHR.nflags(address()); } /** Returns the value of the {@code handleType} field. */ @NativeType("VkExternalSemaphoreHandleTypeFlagBitsKHR") public int handleType() { return VkImportSemaphoreWin32HandleInfoKHR.nhandleType(address()); } /** Returns the value of the {@code handle} field. */ @NativeType("HANDLE") public long handle() { return VkImportSemaphoreWin32HandleInfoKHR.nhandle(address()); } /** Returns a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code name} field. */ @NativeType("LPCWSTR") public ByteBuffer name() { return VkImportSemaphoreWin32HandleInfoKHR.nname(address()); } /** Decodes the null-terminated string pointed to by the {@code name} field. */ @NativeType("LPCWSTR") public String nameString() { return VkImportSemaphoreWin32HandleInfoKHR.nnameString(address()); } /** Sets the specified value to the {@code sType} field. */ public VkImportSemaphoreWin32HandleInfoKHR.Buffer sType(@NativeType("VkStructureType") int value) { VkImportSemaphoreWin32HandleInfoKHR.nsType(address(), value); return this; } /** Sets the specified value to the {@code pNext} field. */ public VkImportSemaphoreWin32HandleInfoKHR.Buffer pNext(@NativeType("const void *") long value) { VkImportSemaphoreWin32HandleInfoKHR.npNext(address(), value); return this; } /** Sets the specified value to the {@code semaphore} field. */ public VkImportSemaphoreWin32HandleInfoKHR.Buffer semaphore(@NativeType("VkSemaphore") long value) { VkImportSemaphoreWin32HandleInfoKHR.nsemaphore(address(), value); return this; } /** Sets the specified value to the {@code flags} field. */ public VkImportSemaphoreWin32HandleInfoKHR.Buffer flags(@NativeType("VkSemaphoreImportFlagsKHR") int value) { VkImportSemaphoreWin32HandleInfoKHR.nflags(address(), value); return this; } /** Sets the specified value to the {@code handleType} field. */ public VkImportSemaphoreWin32HandleInfoKHR.Buffer handleType(@NativeType("VkExternalSemaphoreHandleTypeFlagBitsKHR") int value) { VkImportSemaphoreWin32HandleInfoKHR.nhandleType(address(), value); return this; } /** Sets the specified value to the {@code handle} field. */ public VkImportSemaphoreWin32HandleInfoKHR.Buffer handle(@NativeType("HANDLE") long value) { VkImportSemaphoreWin32HandleInfoKHR.nhandle(address(), value); return this; } /** Sets the address of the specified encoded string to the {@code name} field. */ public VkImportSemaphoreWin32HandleInfoKHR.Buffer name(@NativeType("LPCWSTR") ByteBuffer value) { VkImportSemaphoreWin32HandleInfoKHR.nname(address(), value); return this; } } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy