org.lwjgl.util.nfd.NFDSaveDialogArgs Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of lwjgl-nfd Show documentation
Show all versions of lwjgl-nfd Show documentation
A tiny, neat C library that portably invokes native file open and save dialogs.
The newest version!
/*
* Copyright LWJGL. All rights reserved.
* License terms: https://www.lwjgl.org/license
* MACHINE GENERATED FILE, DO NOT EDIT
*/
package org.lwjgl.util.nfd;
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.*;
/**
* Layout
*
*
* struct nfdsavedialogu8args_t {
* {@link NFDFilterItem nfdfilteritem_t} const * filterList;
* nfdfiltersize_t filterCount;
* nfdchar_t const * defaultPath;
* nfdchar_t const * defaultName;
* {@link NFDWindowHandle nfdwindowhandle_t} parentWindow;
* }
*/
@NativeType("struct nfdsavedialogu8args_t")
public class NFDSaveDialogArgs 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
FILTERLIST,
FILTERCOUNT,
DEFAULTPATH,
DEFAULTNAME,
PARENTWINDOW;
static {
Layout layout = __struct(
__member(POINTER_SIZE),
__member(4),
__member(POINTER_SIZE),
__member(POINTER_SIZE),
__member(NFDWindowHandle.SIZEOF, NFDWindowHandle.ALIGNOF)
);
SIZEOF = layout.getSize();
ALIGNOF = layout.getAlignment();
FILTERLIST = layout.offsetof(0);
FILTERCOUNT = layout.offsetof(1);
DEFAULTPATH = layout.offsetof(2);
DEFAULTNAME = layout.offsetof(3);
PARENTWINDOW = layout.offsetof(4);
}
protected NFDSaveDialogArgs(long address, @Nullable ByteBuffer container) {
super(address, container);
}
@Override
protected NFDSaveDialogArgs create(long address, @Nullable ByteBuffer container) {
return new NFDSaveDialogArgs(address, container);
}
/**
* Creates a {@code NFDSaveDialogArgs} 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 NFDSaveDialogArgs(ByteBuffer container) {
super(memAddress(container), __checkContainer(container, SIZEOF));
}
@Override
public int sizeof() { return SIZEOF; }
/** @return a {@link NFDFilterItem.Buffer} view of the struct array pointed to by the {@code filterList} field. */
@Nullable
@NativeType("nfdfilteritem_t const *")
public NFDFilterItem.Buffer filterList() { return nfilterList(address()); }
/** @return the value of the {@code filterCount} field. */
@NativeType("nfdfiltersize_t")
public int filterCount() { return nfilterCount(address()); }
/** @return a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code defaultPath} field. */
@Nullable
@NativeType("nfdchar_t const *")
public ByteBuffer defaultPath() { return ndefaultPath(address()); }
/** @return the null-terminated string pointed to by the {@code defaultPath} field. */
@Nullable
@NativeType("nfdchar_t const *")
public String defaultPathString() { return ndefaultPathString(address()); }
/** @return a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code defaultName} field. */
@Nullable
@NativeType("nfdchar_t const *")
public ByteBuffer defaultName() { return ndefaultName(address()); }
/** @return the null-terminated string pointed to by the {@code defaultName} field. */
@Nullable
@NativeType("nfdchar_t const *")
public String defaultNameString() { return ndefaultNameString(address()); }
/** @return a {@link NFDWindowHandle} view of the {@code parentWindow} field. */
@NativeType("nfdwindowhandle_t")
public NFDWindowHandle parentWindow() { return nparentWindow(address()); }
/** Sets the address of the specified {@link NFDFilterItem.Buffer} to the {@code filterList} field. */
public NFDSaveDialogArgs filterList(@Nullable @NativeType("nfdfilteritem_t const *") NFDFilterItem.Buffer value) { nfilterList(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code defaultPath} field. */
public NFDSaveDialogArgs defaultPath(@Nullable @NativeType("nfdchar_t const *") ByteBuffer value) { ndefaultPath(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code defaultName} field. */
public NFDSaveDialogArgs defaultName(@Nullable @NativeType("nfdchar_t const *") ByteBuffer value) { ndefaultName(address(), value); return this; }
/** Copies the specified {@link NFDWindowHandle} to the {@code parentWindow} field. */
public NFDSaveDialogArgs parentWindow(@NativeType("nfdwindowhandle_t") NFDWindowHandle value) { nparentWindow(address(), value); return this; }
/** Passes the {@code parentWindow} field to the specified {@link java.util.function.Consumer Consumer}. */
public NFDSaveDialogArgs parentWindow(java.util.function.Consumer consumer) { consumer.accept(parentWindow()); return this; }
/** Initializes this struct with the specified values. */
public NFDSaveDialogArgs set(
@Nullable NFDFilterItem.Buffer filterList,
@Nullable ByteBuffer defaultPath,
@Nullable ByteBuffer defaultName,
NFDWindowHandle parentWindow
) {
filterList(filterList);
defaultPath(defaultPath);
defaultName(defaultName);
parentWindow(parentWindow);
return this;
}
/**
* Copies the specified struct data to this struct.
*
* @param src the source struct
*
* @return this struct
*/
public NFDSaveDialogArgs set(NFDSaveDialogArgs src) {
memCopy(src.address(), address(), SIZEOF);
return this;
}
// -----------------------------------
/** Returns a new {@code NFDSaveDialogArgs} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed. */
public static NFDSaveDialogArgs malloc() {
return new NFDSaveDialogArgs(nmemAllocChecked(SIZEOF), null);
}
/** Returns a new {@code NFDSaveDialogArgs} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed. */
public static NFDSaveDialogArgs calloc() {
return new NFDSaveDialogArgs(nmemCallocChecked(1, SIZEOF), null);
}
/** Returns a new {@code NFDSaveDialogArgs} instance allocated with {@link BufferUtils}. */
public static NFDSaveDialogArgs create() {
ByteBuffer container = BufferUtils.createByteBuffer(SIZEOF);
return new NFDSaveDialogArgs(memAddress(container), container);
}
/** Returns a new {@code NFDSaveDialogArgs} instance for the specified memory address. */
public static NFDSaveDialogArgs create(long address) {
return new NFDSaveDialogArgs(address, null);
}
/** Like {@link #create(long) create}, but returns {@code null} if {@code address} is {@code NULL}. */
@Nullable
public static NFDSaveDialogArgs createSafe(long address) {
return address == NULL ? null : new NFDSaveDialogArgs(address, null);
}
/**
* Returns a new {@link NFDSaveDialogArgs.Buffer} instance allocated with {@link MemoryUtil#memAlloc memAlloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static NFDSaveDialogArgs.Buffer malloc(int capacity) {
return new Buffer(nmemAllocChecked(__checkMalloc(capacity, SIZEOF)), capacity);
}
/**
* Returns a new {@link NFDSaveDialogArgs.Buffer} instance allocated with {@link MemoryUtil#memCalloc memCalloc}. The instance must be explicitly freed.
*
* @param capacity the buffer capacity
*/
public static NFDSaveDialogArgs.Buffer calloc(int capacity) {
return new Buffer(nmemCallocChecked(capacity, SIZEOF), capacity);
}
/**
* Returns a new {@link NFDSaveDialogArgs.Buffer} instance allocated with {@link BufferUtils}.
*
* @param capacity the buffer capacity
*/
public static NFDSaveDialogArgs.Buffer create(int capacity) {
ByteBuffer container = __create(capacity, SIZEOF);
return new Buffer(memAddress(container), container, -1, 0, capacity, capacity);
}
/**
* Create a {@link NFDSaveDialogArgs.Buffer} instance at the specified memory.
*
* @param address the memory address
* @param capacity the buffer capacity
*/
public static NFDSaveDialogArgs.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 NFDSaveDialogArgs.Buffer createSafe(long address, int capacity) {
return address == NULL ? null : new Buffer(address, capacity);
}
/**
* Returns a new {@code NFDSaveDialogArgs} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
*/
public static NFDSaveDialogArgs malloc(MemoryStack stack) {
return new NFDSaveDialogArgs(stack.nmalloc(ALIGNOF, SIZEOF), null);
}
/**
* Returns a new {@code NFDSaveDialogArgs} instance allocated on the specified {@link MemoryStack} and initializes all its bits to zero.
*
* @param stack the stack from which to allocate
*/
public static NFDSaveDialogArgs calloc(MemoryStack stack) {
return new NFDSaveDialogArgs(stack.ncalloc(ALIGNOF, 1, SIZEOF), null);
}
/**
* Returns a new {@link NFDSaveDialogArgs.Buffer} instance allocated on the specified {@link MemoryStack}.
*
* @param stack the stack from which to allocate
* @param capacity the buffer capacity
*/
public static NFDSaveDialogArgs.Buffer malloc(int capacity, MemoryStack stack) {
return new Buffer(stack.nmalloc(ALIGNOF, capacity * SIZEOF), capacity);
}
/**
* Returns a new {@link NFDSaveDialogArgs.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 NFDSaveDialogArgs.Buffer calloc(int capacity, MemoryStack stack) {
return new Buffer(stack.ncalloc(ALIGNOF, capacity, SIZEOF), capacity);
}
// -----------------------------------
/** Unsafe version of {@link #filterList}. */
@Nullable public static NFDFilterItem.Buffer nfilterList(long struct) { return NFDFilterItem.createSafe(memGetAddress(struct + NFDSaveDialogArgs.FILTERLIST), nfilterCount(struct)); }
/** Unsafe version of {@link #filterCount}. */
public static int nfilterCount(long struct) { return UNSAFE.getInt(null, struct + NFDSaveDialogArgs.FILTERCOUNT); }
/** Unsafe version of {@link #defaultPath}. */
@Nullable public static ByteBuffer ndefaultPath(long struct) { return memByteBufferNT1Safe(memGetAddress(struct + NFDSaveDialogArgs.DEFAULTPATH)); }
/** Unsafe version of {@link #defaultPathString}. */
@Nullable public static String ndefaultPathString(long struct) { return memUTF8Safe(memGetAddress(struct + NFDSaveDialogArgs.DEFAULTPATH)); }
/** Unsafe version of {@link #defaultName}. */
@Nullable public static ByteBuffer ndefaultName(long struct) { return memByteBufferNT1Safe(memGetAddress(struct + NFDSaveDialogArgs.DEFAULTNAME)); }
/** Unsafe version of {@link #defaultNameString}. */
@Nullable public static String ndefaultNameString(long struct) { return memUTF8Safe(memGetAddress(struct + NFDSaveDialogArgs.DEFAULTNAME)); }
/** Unsafe version of {@link #parentWindow}. */
public static NFDWindowHandle nparentWindow(long struct) { return NFDWindowHandle.create(struct + NFDSaveDialogArgs.PARENTWINDOW); }
/** Unsafe version of {@link #filterList(NFDFilterItem.Buffer) filterList}. */
public static void nfilterList(long struct, @Nullable NFDFilterItem.Buffer value) { memPutAddress(struct + NFDSaveDialogArgs.FILTERLIST, memAddressSafe(value)); nfilterCount(struct, value == null ? 0 : value.remaining()); }
/** Sets the specified value to the {@code filterCount} field of the specified {@code struct}. */
public static void nfilterCount(long struct, int value) { UNSAFE.putInt(null, struct + NFDSaveDialogArgs.FILTERCOUNT, value); }
/** Unsafe version of {@link #defaultPath(ByteBuffer) defaultPath}. */
public static void ndefaultPath(long struct, @Nullable ByteBuffer value) {
if (CHECKS) { checkNT1Safe(value); }
memPutAddress(struct + NFDSaveDialogArgs.DEFAULTPATH, memAddressSafe(value));
}
/** Unsafe version of {@link #defaultName(ByteBuffer) defaultName}. */
public static void ndefaultName(long struct, @Nullable ByteBuffer value) {
if (CHECKS) { checkNT1Safe(value); }
memPutAddress(struct + NFDSaveDialogArgs.DEFAULTNAME, memAddressSafe(value));
}
/** Unsafe version of {@link #parentWindow(NFDWindowHandle) parentWindow}. */
public static void nparentWindow(long struct, NFDWindowHandle value) { memCopy(value.address(), struct + NFDSaveDialogArgs.PARENTWINDOW, NFDWindowHandle.SIZEOF); }
/**
* Validates pointer members that should not be {@code NULL}.
*
* @param struct the struct to validate
*/
public static void validate(long struct) {
int filterCount = nfilterCount(struct);
if (filterCount != 0) {
long filterList = memGetAddress(struct + NFDSaveDialogArgs.FILTERLIST);
check(filterList);
validate(filterList, filterCount, NFDFilterItem.SIZEOF, NFDFilterItem::validate);
}
}
// -----------------------------------
/** An array of {@link NFDSaveDialogArgs} structs. */
public static class Buffer extends StructBuffer implements NativeResource {
private static final NFDSaveDialogArgs ELEMENT_FACTORY = NFDSaveDialogArgs.create(-1L);
/**
* Creates a new {@code NFDSaveDialogArgs.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 NFDSaveDialogArgs#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 NFDSaveDialogArgs getElementFactory() {
return ELEMENT_FACTORY;
}
/** @return a {@link NFDFilterItem.Buffer} view of the struct array pointed to by the {@code filterList} field. */
@Nullable
@NativeType("nfdfilteritem_t const *")
public NFDFilterItem.Buffer filterList() { return NFDSaveDialogArgs.nfilterList(address()); }
/** @return the value of the {@code filterCount} field. */
@NativeType("nfdfiltersize_t")
public int filterCount() { return NFDSaveDialogArgs.nfilterCount(address()); }
/** @return a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code defaultPath} field. */
@Nullable
@NativeType("nfdchar_t const *")
public ByteBuffer defaultPath() { return NFDSaveDialogArgs.ndefaultPath(address()); }
/** @return the null-terminated string pointed to by the {@code defaultPath} field. */
@Nullable
@NativeType("nfdchar_t const *")
public String defaultPathString() { return NFDSaveDialogArgs.ndefaultPathString(address()); }
/** @return a {@link ByteBuffer} view of the null-terminated string pointed to by the {@code defaultName} field. */
@Nullable
@NativeType("nfdchar_t const *")
public ByteBuffer defaultName() { return NFDSaveDialogArgs.ndefaultName(address()); }
/** @return the null-terminated string pointed to by the {@code defaultName} field. */
@Nullable
@NativeType("nfdchar_t const *")
public String defaultNameString() { return NFDSaveDialogArgs.ndefaultNameString(address()); }
/** @return a {@link NFDWindowHandle} view of the {@code parentWindow} field. */
@NativeType("nfdwindowhandle_t")
public NFDWindowHandle parentWindow() { return NFDSaveDialogArgs.nparentWindow(address()); }
/** Sets the address of the specified {@link NFDFilterItem.Buffer} to the {@code filterList} field. */
public NFDSaveDialogArgs.Buffer filterList(@Nullable @NativeType("nfdfilteritem_t const *") NFDFilterItem.Buffer value) { NFDSaveDialogArgs.nfilterList(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code defaultPath} field. */
public NFDSaveDialogArgs.Buffer defaultPath(@Nullable @NativeType("nfdchar_t const *") ByteBuffer value) { NFDSaveDialogArgs.ndefaultPath(address(), value); return this; }
/** Sets the address of the specified encoded string to the {@code defaultName} field. */
public NFDSaveDialogArgs.Buffer defaultName(@Nullable @NativeType("nfdchar_t const *") ByteBuffer value) { NFDSaveDialogArgs.ndefaultName(address(), value); return this; }
/** Copies the specified {@link NFDWindowHandle} to the {@code parentWindow} field. */
public NFDSaveDialogArgs.Buffer parentWindow(@NativeType("nfdwindowhandle_t") NFDWindowHandle value) { NFDSaveDialogArgs.nparentWindow(address(), value); return this; }
/** Passes the {@code parentWindow} field to the specified {@link java.util.function.Consumer Consumer}. */
public NFDSaveDialogArgs.Buffer parentWindow(java.util.function.Consumer consumer) { consumer.accept(parentWindow()); return this; }
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy