Package org.lwjgl.util.nfd

Class NFDOpenDialogArgs

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<NFDOpenDialogArgs>

org.lwjgl.util.nfd.NFDOpenDialogArgs

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class NFDOpenDialogArgs
extends Struct<NFDOpenDialogArgs>
implements NativeResource

 struct nfdopendialogu8args_t {
     {@link NFDFilterItem nfdfilteritem_t} const * filterList;
     nfdfiltersize_t filterCount;
     nfdchar_t const * defaultPath;
     {@link NFDWindowHandle nfdwindowhandle_t} parentWindow;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NFDOpenDialogArgs.Buffer	An array of NFDOpenDialogArgs structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DEFAULTPATH	The struct member offsets.
static final int	FILTERCOUNT	The struct member offsets.
static final int	FILTERLIST	The struct member offsets.
static final int	PARENTWINDOW	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
NFDOpenDialogArgs(ByteBuffer container)	Creates a NFDOpenDialogArgs instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static NFDOpenDialogArgs	calloc()	Returns a new NFDOpenDialogArgs instance allocated with memCalloc.
static NFDOpenDialogArgs.Buffer	calloc(int capacity)	Returns a new NFDOpenDialogArgs.Buffer instance allocated with memCalloc.
static NFDOpenDialogArgs.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new NFDOpenDialogArgs.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static NFDOpenDialogArgs	calloc(MemoryStack stack)	Returns a new NFDOpenDialogArgs instance allocated on the specified MemoryStack and initializes all its bits to zero.
static NFDOpenDialogArgs	create()	Returns a new NFDOpenDialogArgs instance allocated with BufferUtils.
static NFDOpenDialogArgs.Buffer	create(int capacity)	Returns a new NFDOpenDialogArgs.Buffer instance allocated with BufferUtils.
static NFDOpenDialogArgs	create(long address)	Returns a new NFDOpenDialogArgs instance for the specified memory address.
static NFDOpenDialogArgs.Buffer	create(long address, int capacity)	Create a NFDOpenDialogArgs.Buffer instance at the specified memory.
static @Nullable NFDOpenDialogArgs	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable NFDOpenDialogArgs.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
@Nullable ByteBuffer	defaultPath()
NFDOpenDialogArgs	defaultPath(@Nullable ByteBuffer value)	Sets the address of the specified encoded string to the defaultPath field.
@Nullable String	defaultPathString()
int	filterCount()
@Nullable NFDFilterItem.Buffer	filterList()
NFDOpenDialogArgs	filterList(@Nullable NFDFilterItem.Buffer value)	Sets the address of the specified NFDFilterItem.Buffer to the filterList field.
static NFDOpenDialogArgs	malloc()	Returns a new NFDOpenDialogArgs instance allocated with memAlloc.
static NFDOpenDialogArgs.Buffer	malloc(int capacity)	Returns a new NFDOpenDialogArgs.Buffer instance allocated with memAlloc.
static NFDOpenDialogArgs.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new NFDOpenDialogArgs.Buffer instance allocated on the specified MemoryStack.
static NFDOpenDialogArgs	malloc(MemoryStack stack)	Returns a new NFDOpenDialogArgs instance allocated on the specified MemoryStack.
static @Nullable ByteBuffer	ndefaultPath(long struct)	Unsafe version of defaultPath().
static void	ndefaultPath(long struct, @Nullable ByteBuffer value)	Unsafe version of defaultPath.
static @Nullable String	ndefaultPathString(long struct)	Unsafe version of defaultPathString().
static int	nfilterCount(long struct)	Unsafe version of filterCount().
static void	nfilterCount(long struct, int value)	Sets the specified value to the filterCount field of the specified struct.
static @Nullable NFDFilterItem.Buffer	nfilterList(long struct)	Unsafe version of filterList().
static void	nfilterList(long struct, @Nullable NFDFilterItem.Buffer value)	Unsafe version of filterList.
static NFDWindowHandle	nparentWindow(long struct)	Unsafe version of parentWindow().
static void	nparentWindow(long struct, NFDWindowHandle value)	Unsafe version of parentWindow.
NFDWindowHandle	parentWindow()
NFDOpenDialogArgs	parentWindow(Consumer<NFDWindowHandle> consumer)	Passes the parentWindow field to the specified Consumer.
NFDOpenDialogArgs	parentWindow(NFDWindowHandle value)	Copies the specified NFDWindowHandle to the parentWindow field.
NFDOpenDialogArgs	set(@Nullable NFDFilterItem.Buffer filterList, @Nullable ByteBuffer defaultPath, NFDWindowHandle parentWindow)	Initializes this struct with the specified values.
NFDOpenDialogArgs	set(NFDOpenDialogArgs src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

FILTERLIST

public static final int FILTERLIST

The struct member offsets.

FILTERCOUNT

public static final int FILTERCOUNT

The struct member offsets.

DEFAULTPATH

public static final int DEFAULTPATH

The struct member offsets.

PARENTWINDOW

public static final int PARENTWINDOW

The struct member offsets.

Constructor Details

NFDOpenDialogArgs

public NFDOpenDialogArgs(ByteBuffer container)

Creates a NFDOpenDialogArgs instance at the current position of the specified 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.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<NFDOpenDialogArgs>

filterList

public @Nullable NFDFilterItem.Buffer filterList()

Returns:

a NFDFilterItem.Buffer view of the struct array pointed to by the filterList field.

filterCount

public int filterCount()

Returns:

the value of the filterCount field.

defaultPath

public @Nullable ByteBuffer defaultPath()

Returns:

a ByteBuffer view of the null-terminated string pointed to by the defaultPath field.

defaultPathString

public @Nullable String defaultPathString()

Returns:

the null-terminated string pointed to by the defaultPath field.

parentWindow

public NFDWindowHandle parentWindow()

Returns:

a NFDWindowHandle view of the parentWindow field.

filterList

public NFDOpenDialogArgs filterList(@Nullable NFDFilterItem.Buffer value)

Sets the address of the specified NFDFilterItem.Buffer to the filterList field.

defaultPath

public NFDOpenDialogArgs defaultPath(@Nullable ByteBuffer value)

Sets the address of the specified encoded string to the defaultPath field.

parentWindow

public NFDOpenDialogArgs parentWindow(NFDWindowHandle value)

Copies the specified NFDWindowHandle to the parentWindow field.

parentWindow

public NFDOpenDialogArgs parentWindow(Consumer<NFDWindowHandle> consumer)

Passes the parentWindow field to the specified Consumer.

set

public NFDOpenDialogArgs set(@Nullable NFDFilterItem.Buffer filterList,
 @Nullable ByteBuffer defaultPath,
 NFDWindowHandle parentWindow)

Initializes this struct with the specified values.

set

public NFDOpenDialogArgs set(NFDOpenDialogArgs src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static NFDOpenDialogArgs malloc()

Returns a new NFDOpenDialogArgs instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static NFDOpenDialogArgs calloc()

Returns a new NFDOpenDialogArgs instance allocated with memCalloc. The instance must be explicitly freed.

create

public static NFDOpenDialogArgs create()

Returns a new NFDOpenDialogArgs instance allocated with BufferUtils.

create

public static NFDOpenDialogArgs create(long address)

Returns a new NFDOpenDialogArgs instance for the specified memory address.

createSafe

public static @Nullable NFDOpenDialogArgs createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static NFDOpenDialogArgs.Buffer malloc(int capacity)

Returns a new NFDOpenDialogArgs.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static NFDOpenDialogArgs.Buffer calloc(int capacity)

Returns a new NFDOpenDialogArgs.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static NFDOpenDialogArgs.Buffer create(int capacity)

Returns a new NFDOpenDialogArgs.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static NFDOpenDialogArgs.Buffer create(long address,
 int capacity)

Create a NFDOpenDialogArgs.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable NFDOpenDialogArgs.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static NFDOpenDialogArgs malloc(MemoryStack stack)

Returns a new NFDOpenDialogArgs instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static NFDOpenDialogArgs calloc(MemoryStack stack)

Returns a new NFDOpenDialogArgs instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static NFDOpenDialogArgs.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new NFDOpenDialogArgs.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static NFDOpenDialogArgs.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new NFDOpenDialogArgs.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nfilterList

public static @Nullable NFDFilterItem.Buffer nfilterList(long struct)

Unsafe version of filterList().

nfilterCount

public static int nfilterCount(long struct)

Unsafe version of filterCount().

ndefaultPath

public static @Nullable ByteBuffer ndefaultPath(long struct)

Unsafe version of defaultPath().

ndefaultPathString

public static @Nullable String ndefaultPathString(long struct)

Unsafe version of defaultPathString().

nparentWindow

public static NFDWindowHandle nparentWindow(long struct)

Unsafe version of parentWindow().

nfilterList

public static void nfilterList(long struct,
 @Nullable NFDFilterItem.Buffer value)

Unsafe version of filterList.

nfilterCount

public static void nfilterCount(long struct,
 int value)

Sets the specified value to the filterCount field of the specified struct.

ndefaultPath

public static void ndefaultPath(long struct,
 @Nullable ByteBuffer value)

Unsafe version of defaultPath.

nparentWindow

public static void nparentWindow(long struct,
 NFDWindowHandle value)

Unsafe version of parentWindow.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate