Class NFDSaveDialogArgs

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<NFDSaveDialogArgs>

org.lwjgl.util.nfd.NFDSaveDialogArgs

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

@NativeType("struct nfdsavedialogu8args_t")
public class NFDSaveDialogArgs
extends Struct<NFDSaveDialogArgs>
implements NativeResource

struct nfdsavedialogu8args_t {
    nfdfilteritem_t const * filterList;
    nfdfiltersize_t filterCount;
    nfdchar_t const * defaultPath;
    nfdchar_t const * defaultName;
    nfdwindowhandle_t parentWindow;
}

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	DEFAULTNAME	The struct member offsets.
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 Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static NFDSaveDialogArgs	calloc()	Returns a new NFDSaveDialogArgs instance allocated with memCalloc.
static NFDSaveDialogArgs.Buffer	calloc(int capacity)	Returns a new NFDSaveDialogArgs.Buffer instance allocated with memCalloc.
static NFDSaveDialogArgs.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new NFDSaveDialogArgs.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static NFDSaveDialogArgs	calloc(MemoryStack stack)	Returns a new NFDSaveDialogArgs instance allocated on the specified MemoryStack and initializes all its bits to zero.
static NFDSaveDialogArgs	create()	Returns a new NFDSaveDialogArgs instance allocated with BufferUtils.
static NFDSaveDialogArgs.Buffer	create(int capacity)	Returns a new NFDSaveDialogArgs.Buffer instance allocated with BufferUtils.
static NFDSaveDialogArgs	create(long address)	Returns a new NFDSaveDialogArgs instance for the specified memory address.
static NFDSaveDialogArgs.Buffer	create(long address, int capacity)	Create a NFDSaveDialogArgs.Buffer instance at the specified memory.
static @Nullable NFDSaveDialogArgs	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable NFDSaveDialogArgs.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
@Nullable ByteBuffer	defaultName()
NFDSaveDialogArgs	defaultName(@Nullable ByteBuffer value)	Sets the address of the specified encoded string to the defaultName field.
@Nullable String	defaultNameString()
@Nullable ByteBuffer	defaultPath()
NFDSaveDialogArgs	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()
NFDSaveDialogArgs	filterList(@Nullable NFDFilterItem.Buffer value)	Sets the address of the specified NFDFilterItem.Buffer to the filterList field.
static NFDSaveDialogArgs	malloc()	Returns a new NFDSaveDialogArgs instance allocated with memAlloc.
static NFDSaveDialogArgs.Buffer	malloc(int capacity)	Returns a new NFDSaveDialogArgs.Buffer instance allocated with memAlloc.
static NFDSaveDialogArgs.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new NFDSaveDialogArgs.Buffer instance allocated on the specified MemoryStack.
static NFDSaveDialogArgs	malloc(MemoryStack stack)	Returns a new NFDSaveDialogArgs instance allocated on the specified MemoryStack.
static @Nullable ByteBuffer	ndefaultName(long struct)	Unsafe version of defaultName().
static void	ndefaultName(long struct, @Nullable ByteBuffer value)	Unsafe version of defaultName.
static @Nullable String	ndefaultNameString(long struct)	Unsafe version of defaultNameString().
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()
NFDSaveDialogArgs	parentWindow(Consumer<NFDWindowHandle> consumer)	Passes the parentWindow field to the specified Consumer.
NFDSaveDialogArgs	parentWindow(NFDWindowHandle value)	Copies the specified NFDWindowHandle to the parentWindow field.
NFDSaveDialogArgs	set(@Nullable NFDFilterItem.Buffer filterList, @Nullable ByteBuffer defaultPath, @Nullable ByteBuffer defaultName, NFDWindowHandle parentWindow)	Initializes this struct with the specified values.
NFDSaveDialogArgs	set(NFDSaveDialogArgs 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 Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

DEFAULTNAME

public static final int DEFAULTNAME

The struct member offsets.

PARENTWINDOW

public static final int PARENTWINDOW

The struct member offsets.

Constructor Details

NFDSaveDialogArgs

public NFDSaveDialogArgs(ByteBuffer container)

Creates a NFDSaveDialogArgs 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<NFDSaveDialogArgs>

filterList

@NativeType("nfdfilteritem_t const *")
public @Nullable NFDFilterItem.Buffer filterList()

Returns:

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

filterCount

@NativeType("nfdfiltersize_t")
public int filterCount()

Returns:

the value of the filterCount field.

defaultPath

@NativeType("nfdchar_t const *")
public @Nullable ByteBuffer defaultPath()

Returns:

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

defaultPathString

@NativeType("nfdchar_t const *")
public @Nullable String defaultPathString()

Returns:

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

defaultName

@NativeType("nfdchar_t const *")
public @Nullable ByteBuffer defaultName()

Returns:

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

defaultNameString

@NativeType("nfdchar_t const *")
public @Nullable String defaultNameString()

Returns:

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

parentWindow

@NativeType("nfdwindowhandle_t")
public NFDWindowHandle parentWindow()

Returns:

a NFDWindowHandle view of the parentWindow field.

filterList

public NFDSaveDialogArgs filterList(@NativeType("nfdfilteritem_t const *")
 @Nullable NFDFilterItem.Buffer value)

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

defaultPath

public NFDSaveDialogArgs defaultPath(@NativeType("nfdchar_t const *")
 @Nullable ByteBuffer value)

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

defaultName

public NFDSaveDialogArgs defaultName(@NativeType("nfdchar_t const *")
 @Nullable ByteBuffer value)

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

parentWindow

public NFDSaveDialogArgs parentWindow(@NativeType("nfdwindowhandle_t")
 NFDWindowHandle value)

Copies the specified NFDWindowHandle to the parentWindow field.

parentWindow

public NFDSaveDialogArgs parentWindow(Consumer<NFDWindowHandle> consumer)

Passes the parentWindow field to the specified Consumer.

set

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

Initializes this struct with the specified values.

set

public NFDSaveDialogArgs set(NFDSaveDialogArgs src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static NFDSaveDialogArgs malloc()

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

calloc

public static NFDSaveDialogArgs calloc()

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

create

public static NFDSaveDialogArgs create()

Returns a new NFDSaveDialogArgs instance allocated with BufferUtils.

create

public static NFDSaveDialogArgs create(long address)

Returns a new NFDSaveDialogArgs instance for the specified memory address.

createSafe

public static @Nullable NFDSaveDialogArgs createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static NFDSaveDialogArgs.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static NFDSaveDialogArgs.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static NFDSaveDialogArgs.Buffer create(int capacity)

Returns a new NFDSaveDialogArgs.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a NFDSaveDialogArgs.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static NFDSaveDialogArgs malloc(MemoryStack stack)

Returns a new NFDSaveDialogArgs instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static NFDSaveDialogArgs calloc(MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new NFDSaveDialogArgs.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().

ndefaultName

public static @Nullable ByteBuffer ndefaultName(long struct)

Unsafe version of defaultName().

ndefaultNameString

public static @Nullable String ndefaultNameString(long struct)

Unsafe version of defaultNameString().

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.

ndefaultName

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

Unsafe version of defaultName.

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