org.lwjgl.cuda.CUDA_ARRAY_DESCRIPTOR Maven / Gradle / Ivy
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.cuda;
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.*;
/**
* Array descriptor.
*
* Layout
*
*
* struct CUDA_ARRAY_DESCRIPTOR {
* size_t {@link #Width};
* size_t {@link #Height};
* CUarray_format {@link #Format};
* unsigned int {@link #NumChannels};
* }
*/
public class CUDA_ARRAY_DESCRIPTOR extends Struct implements NativeResource {
/** The struct size in bytes. */
public static final int SIZEOF;
/** The struct alignment in bytes. */
public static final int ALIGNOF;
/** The struct member offsets. */
public static final int
WIDTH,
HEIGHT,
FORMAT,
NUMCHANNELS;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(4),
__member(4)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
WIDTH = layout.offsetof(0);
HEIGHT = layout.offsetof(1);
FORMAT = layout.offsetof(2);
NUMCHANNELS = layout.offsetof(3);
}
/**
* Creates a {@code CUDA_ARRAY_DESCRIPTOR} 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 CUDA_ARRAY_DESCRIPTOR(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** Width of array */
@NativeType("size_t")
public long Width() { return nWidth(address()); }
/** Height of array */
@NativeType("size_t")
public long Height() { return nHeight(address()); }
/** Array format */
@NativeType("CUarray_format")
public int Format() { return nFormat(address()); }
/** Channels per array element */
@NativeType("unsigned int")
public int NumChannels() { return nNumChannels(address()); }
/** Sets the specified value to the {@link #Width} field. */
public CUDA_ARRAY_DESCRIPTOR Width(@NativeType("size_t") long value) { nWidth(address(), value); return this; }
/** Sets the specified value to the {@link #Height} field. */
public CUDA_ARRAY_DESCRIPTOR Height(@NativeType("size_t") long value) { nHeight(address(), value); return this; }
/** Sets the specified value to the {@link #Format} field. */
public CUDA_ARRAY_DESCRIPTOR Format(@NativeType("CUarray_format") int value) { nFormat(address(), value); return this; }
/** Sets the specified value to the {@link #NumChannels} field. */
public CUDA_ARRAY_DESCRIPTOR NumChannels(@NativeType("unsigned int") int value) { nNumChannels(address(), value); return this; }
/** Initializes this struct with the specified values. */
public CUDA_ARRAY_DESCRIPTOR set(
long Width,
long Height,
int Format,
int NumChannels
) {
Width(Width);
Height(Height);
Format(Format);
NumChannels(NumChannels);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public CUDA_ARRAY_DESCRIPTOR set(CUDA_ARRAY_DESCRIPTOR src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code CUDA_ARRAY_DESCRIPTOR} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static CUDA_ARRAY_DESCRIPTOR malloc() {
return wrap(CUDA_ARRAY_DESCRIPTOR.class, nmemAllocChecked(SIZEOF));
}
/** Returns a new {@code CUDA_ARRAY_DESCRIPTOR} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static CUDA_ARRAY_DESCRIPTOR calloc() {
return wrap(CUDA_ARRAY_DESCRIPTOR.class, nmemCallocChecked(1, SIZEOF));
}
/** Returns a new {@code CUDA_ARRAY_DESCRIPTOR} instance allocated with {@link BufferUtils}. */
public static CUDA_ARRAY_DESCRIPTOR create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return wrap(CUDA_ARRAY_DESCRIPTOR.class, memAddress(container), container);
}
/** Returns a new {@code CUDA_ARRAY_DESCRIPTOR} instance for the specified memory address. */
public static CUDA_ARRAY_DESCRIPTOR create(long address) {
return wrap(CUDA_ARRAY_DESCRIPTOR.class, address);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static CUDA_ARRAY_DESCRIPTOR createSafe(long address) {
return address == NULL ? null : wrap(CUDA_ARRAY_DESCRIPTOR.class, address);
}
/**
* Returns a new {@link CUDA_ARRAY_DESCRIPTOR.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static CUDA_ARRAY_DESCRIPTOR.Buffer malloc(int capacity) {
return wrap(Buffer.class, nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link CUDA_ARRAY_DESCRIPTOR.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static CUDA_ARRAY_DESCRIPTOR.Buffer calloc(int capacity) {
return wrap(Buffer.class, nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link CUDA_ARRAY_DESCRIPTOR.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static CUDA_ARRAY_DESCRIPTOR.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return wrap(Buffer.class, memAddress(container), capacity, container);
}
/**
* Create a {@link CUDA_ARRAY_DESCRIPTOR.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static CUDA_ARRAY_DESCRIPTOR.Buffer create(long address, int capacity) {
return wrap(Buffer.class, address, capacity);
}
/** Like {@link #create(long, int) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static CUDA_ARRAY_DESCRIPTOR.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : wrap(Buffer.class, address, capacity);
}
// -----------------------------------
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR mallocStack() { return malloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR callocStack() { return calloc(stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR mallocStack(MemoryStack stack) { return malloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR callocStack(MemoryStack stack) { return calloc(stack); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR.Buffer mallocStack(int capacity) { return malloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR.Buffer callocStack(int capacity) { return calloc(capacity, stackGet()); }
/** Deprecated for removal in 3.4.0. Use {@link #malloc(int, MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR.Buffer mallocStack(int capacity, MemoryStack stack) { return malloc(capacity, stack); }
/** Deprecated for removal in 3.4.0. Use {@link #calloc(int, MemoryStack)} instead. */
@Deprecated public static CUDA_ARRAY_DESCRIPTOR.Buffer callocStack(int capacity, MemoryStack stack) { return calloc(capacity, stack); }
/**
* Returns a new {@code CUDA_ARRAY_DESCRIPTOR} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static CUDA_ARRAY_DESCRIPTOR malloc(MemoryStack stack) {
return wrap(CUDA_ARRAY_DESCRIPTOR.class, stack.nmalloc(ALIGNOF, SIZEOF));
}
/**
* Returns a new {@code CUDA_ARRAY_DESCRIPTOR} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static CUDA_ARRAY_DESCRIPTOR calloc(MemoryStack stack) {
return wrap(CUDA_ARRAY_DESCRIPTOR.class, stack.ncalloc(ALIGNOF, 1, SIZEOF));
}
/**
* Returns a new {@link CUDA_ARRAY_DESCRIPTOR.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static CUDA_ARRAY_DESCRIPTOR.Buffer malloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link CUDA_ARRAY_DESCRIPTOR.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 CUDA_ARRAY_DESCRIPTOR.Buffer calloc(int capacity, MemoryStack stack) {
return wrap(Buffer.class, stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #Width}. */
public static long nWidth(long struct) { return memGetAddress(struct + CUDA_ARRAY_DESCRIPTOR.WIDTH); }
/** Unsafe version of {@link #Height}. */
public static long nHeight(long struct) { return memGetAddress(struct + CUDA_ARRAY_DESCRIPTOR.HEIGHT); }
/** Unsafe version of {@link #Format}. */
public static int nFormat(long struct) { return UNSAFE.getInt(null, struct + CUDA_ARRAY_DESCRIPTOR.FORMAT); }
/** Unsafe version of {@link #NumChannels}. */
public static int nNumChannels(long struct) { return UNSAFE.getInt(null, struct + CUDA_ARRAY_DESCRIPTOR.NUMCHANNELS); }
/** Unsafe version of {@link #Width(long) Width}. */
public static void nWidth(long struct, long value) { memPutAddress(struct + CUDA_ARRAY_DESCRIPTOR.WIDTH, value); }
/** Unsafe version of {@link #Height(long) Height}. */
public static void nHeight(long struct, long value) { memPutAddress(struct + CUDA_ARRAY_DESCRIPTOR.HEIGHT, value); }
/** Unsafe version of {@link #Format(int) Format}. */
public static void nFormat(long struct, int value) { UNSAFE.putInt(null, struct + CUDA_ARRAY_DESCRIPTOR.FORMAT, value); }
/** Unsafe version of {@link #NumChannels(int) NumChannels}. */
public static void nNumChannels(long struct, int value) { UNSAFE.putInt(null, struct + CUDA_ARRAY_DESCRIPTOR.NUMCHANNELS, value); }
// -----------------------------------
/** An array of {@link CUDA_ARRAY_DESCRIPTOR} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final CUDA_ARRAY_DESCRIPTOR ELEMENT_FACTORY = CUDA_ARRAY_DESCRIPTOR.create(-1L);
/**
* Creates a new {@code CUDA_ARRAY_DESCRIPTOR.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 CUDA_ARRAY_DESCRIPTOR#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 CUDA_ARRAY_DESCRIPTOR getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return the value of the {@link CUDA_ARRAY_DESCRIPTOR#Width} field. */
@NativeType("size_t")
public long Width() { return CUDA_ARRAY_DESCRIPTOR.nWidth(address()); }
/** @return the value of the {@link CUDA_ARRAY_DESCRIPTOR#Height} field. */
@NativeType("size_t")
public long Height() { return CUDA_ARRAY_DESCRIPTOR.nHeight(address()); }
/** @return the value of the {@link CUDA_ARRAY_DESCRIPTOR#Format} field. */
@NativeType("CUarray_format")
public int Format() { return CUDA_ARRAY_DESCRIPTOR.nFormat(address()); }
/** @return the value of the {@link CUDA_ARRAY_DESCRIPTOR#NumChannels} field. */
@NativeType("unsigned int")
public int NumChannels() { return CUDA_ARRAY_DESCRIPTOR.nNumChannels(address()); }
/** Sets the specified value to the {@link CUDA_ARRAY_DESCRIPTOR#Width} field. */
public CUDA_ARRAY_DESCRIPTOR.Buffer Width(@NativeType("size_t") long value) { CUDA_ARRAY_DESCRIPTOR.nWidth(address(), value); return this; }
/** Sets the specified value to the {@link CUDA_ARRAY_DESCRIPTOR#Height} field. */
public CUDA_ARRAY_DESCRIPTOR.Buffer Height(@NativeType("size_t") long value) { CUDA_ARRAY_DESCRIPTOR.nHeight(address(), value); return this; }
/** Sets the specified value to the {@link CUDA_ARRAY_DESCRIPTOR#Format} field. */
public CUDA_ARRAY_DESCRIPTOR.Buffer Format(@NativeType("CUarray_format") int value) { CUDA_ARRAY_DESCRIPTOR.nFormat(address(), value); return this; }
/** Sets the specified value to the {@link CUDA_ARRAY_DESCRIPTOR#NumChannels} field. */
public CUDA_ARRAY_DESCRIPTOR.Buffer NumChannels(@NativeType("unsigned int") int value) { CUDA_ARRAY_DESCRIPTOR.nNumChannels(address(), value); return this; }
}
}