InterfaceInitFunc (java-gi API)

All Superinterfaces:: FunctionPointer

Functional Interface:: This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface @Generated("io.github.jwharm.JavaGI") public interface InterfaceInitFunc extends FunctionPointer

Functional interface declaration of the InterfaceInitFunc callback.

See Also:

Method Summary

Modifier and Type

Method

Description

void

run(TypeInterface gIface, @Nullable MemorySegment ifaceData)

A callback function used by the type system to initialize a new interface.

default MemorySegment

toCallback(Arena arena)

Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.

default void

upcall(MemorySegment gIface, MemorySegment ifaceData)

The upcall method is called from native code.

Method Details
- run
  
  void run(TypeInterface gIface, @Nullable @Nullable MemorySegment ifaceData)
  
  A callback function used by the type system to initialize a new interface.
  This function should initialize all internal data and* allocate any resources required by the interface.
  The members of ifaceData are guaranteed to have been filled with zeros before this function is called.
- upcall
  
  default void upcall(MemorySegment gIface, MemorySegment ifaceData)
  
  The upcall method is called from native code. The parameters are marshaled and run(org.gnome.gobject.TypeInterface, java.lang.foreign.MemorySegment) is executed.
- toCallback
  
  default MemorySegment toCallback(Arena arena)
  
  Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.
  
  Specified by:
  
  toCallback in interface FunctionPointer
  
  Parameters:
  
  arena - the function pointer will be allocated in this arena
  
  Returns:
  
  the native function pointer