flutter

Documentation

Index

• func EngineFlushPendingTasksNow()
• func NumberOfEngines() C.int
• type EngineOpenGL
  • func SelectEngine(index int) *EngineOpenGL
  • func (flu *EngineOpenGL) EngineSendPointerEvent(Event PointerEvent) Result
  • func (flu *EngineOpenGL) EngineSendWindowMetricsEvent(Metric WindowMetricsEvent) Result
  • func (flu *EngineOpenGL) Run(window uintptr, vmArgs []string) Result
  • func (flu *EngineOpenGL) SendPlatformMessage(Message *PlatformMessage) Result
  • func (flu *EngineOpenGL) SendPlatformMessageResponse(responseTo *PlatformMessage, data []byte) Result
  • func (flu *EngineOpenGL) Shutdown() Result
• type Message
• type PlatformMessage
• type PointerEvent
• type PointerPhase
• type Result
• type WindowMetricsEvent

Functions

func EngineFlushPendingTasksNow

func EngineFlushPendingTasksNow()

EngineFlushPendingTasksNow flush tasks on a message loop not controlled by the Flutter engine. deprecated soon.

func NumberOfEngines

func NumberOfEngines() C.int

NumberOfEngines return the number of engine registered into this embedder

Types

type EngineOpenGL

type EngineOpenGL struct {
	// Flutter Engine.
	Engine C.FlutterEngine

	// Necessary callbacks for rendering.
	FMakeCurrent         func(v unsafe.Pointer) bool
	FClearCurrent        func(v unsafe.Pointer) bool
	FPresent             func(v unsafe.Pointer) bool
	FFboCallback         func(v unsafe.Pointer) int32
	FMakeResourceCurrent func(v unsafe.Pointer) bool

	// platform message callback.
	FPlatfromMessage func(message *PlatformMessage, window unsafe.Pointer) bool

	// Engine arguments
	PixelRatio  float64
	AssetsPath  string
	IcuDataPath string
}

EngineOpenGL corresponds to the C.FlutterEngine with his associated callback's method.

func SelectEngine

func SelectEngine(index int) *EngineOpenGL

SelectEngine return a EngineOpenGL from an index

func (*EngineOpenGL) EngineSendPointerEvent

func (flu *EngineOpenGL) EngineSendPointerEvent(Event PointerEvent) Result

EngineSendPointerEvent is used to send an PointerEvent to the Flutter engine.

func (*EngineOpenGL) EngineSendWindowMetricsEvent

func (flu *EngineOpenGL) EngineSendWindowMetricsEvent(Metric WindowMetricsEvent) Result

EngineSendWindowMetricsEvent is used to send a WindowMetricsEvent to the Flutter Engine.

func (*EngineOpenGL) Run

func (flu *EngineOpenGL) Run(window uintptr, vmArgs []string) Result

Run launches the Flutter Engine in a background thread.

func (*EngineOpenGL) SendPlatformMessage

func (flu *EngineOpenGL) SendPlatformMessage(Message *PlatformMessage) Result

SendPlatformMessage is used to send a PlatformMessage to the Flutter engine.

func (*EngineOpenGL) SendPlatformMessageResponse

func (flu *EngineOpenGL) SendPlatformMessageResponse(
	responseTo *PlatformMessage,
	data []byte,
) Result

SendPlatformMessageResponse is used to send a message to the Flutter side using the correct ResponseHandle!

func (*EngineOpenGL) Shutdown

func (flu *EngineOpenGL) Shutdown() Result

Shutdown stops the Flutter engine.

type Message

type Message struct {
	// Describe the method
	Method string `json:"method"`
	// Actual datas
	Args json.RawMessage `json:"args"`
}

Message is the json content of a PlatformMessage

type PlatformMessage

type PlatformMessage struct {
	Channel        string
	Message        Message
	ResponseHandle *C.FlutterPlatformMessageResponseHandle
}

PlatformMessage represents a `MethodChannel` serialized with the `JSONMethodCodec` TODO Support for `StandardMethodCodec`

type PointerEvent

type PointerEvent struct {
	Phase     PointerPhase
	Timestamp int64
	X         float64
	Y         float64
}

PointerEvent represents the position and phase of the mouse at a given time.

type PointerPhase

type PointerPhase int32

PointerPhase corresponds to the C.enum describing phase of the mouse pointer.

const (
	KCancel PointerPhase = C.kCancel
	KUp     PointerPhase = C.kUp
	KDown   PointerPhase = C.kDown
	KMove   PointerPhase = C.kMove
)

Values representing the mouse phase.

type Result

type Result int32

Result corresponds to the C.enum retuned by the shared flutter library whenever we call it.

const (
	KSuccess               Result = C.kSuccess
	KInvalidLibraryVersion Result = C.kInvalidLibraryVersion
	KInvalidArguments      Result = C.kInvalidArguments
)

Values representing the status of an Result.

type WindowMetricsEvent

type WindowMetricsEvent struct {
	Width      int
	Height     int
	PixelRatio float64
}

WindowMetricsEvent represents a window's resolution.