docs
Loading...
Searching...
No Matches
CAPI.h
Go to the documentation of this file.
1///
2/// Copyright (C) 2026 Ultralight, Inc. All rights reserved.
3/// A license is required for commercial use. https://ultralig.ht
4///
5
6///
7/// @file CAPI.h
8///
9/// C API umbrella header. Include this single header to access the core Ultralight C API.
10///
11/// `#include <Ultralight/CAPI.h>`
12///
13/// The native DOM family stays opt-in and is not pulled in here. Include what you use:
14/// `<Ultralight/CAPI/CAPI_DOMDocument.h>` and its `CAPI_DOM*` siblings for documents, nodes,
15/// elements, events, ranges, and selection; `<Ultralight/CAPI/CAPI_DOMTriggers.h>` for
16/// navigation-surviving page listeners; `<Ultralight/CAPI/CAPI_DOMData.h>` for declarative
17/// data binding.
18///
19/// ## API Note
20///
21/// You should only destroy objects that you explicitly create. Do not destroy any objects returned
22/// from the API or callbacks unless otherwise noted.
23///
24#ifndef ULTRALIGHT_CAPI_H
25#define ULTRALIGHT_CAPI_H
26
27#include <Ultralight/CAPI/CAPI_Defines.h>
28#include <Ultralight/CAPI/CAPI_AudioOutput.h>
29#include <Ultralight/CAPI/CAPI_Bitmap.h>
30#include <Ultralight/CAPI/CAPI_Buffer.h>
31#include <Ultralight/CAPI/CAPI_Clipboard.h>
32#include <Ultralight/CAPI/CAPI_Color.h>
33#include <Ultralight/CAPI/CAPI_Config.h>
34#include <Ultralight/CAPI/CAPI_Editor.h>
35#include <Ultralight/CAPI/CAPI_FileSystem.h>
36#include <Ultralight/CAPI/CAPI_FontFile.h>
37#include <Ultralight/CAPI/CAPI_FontLoader.h>
38#include <Ultralight/CAPI/CAPI_Geometry.h>
39#include <Ultralight/CAPI/CAPI_GPUDriver.h>
40#include <Ultralight/CAPI/CAPI_ImageSource.h>
41#include <Ultralight/CAPI/CAPI_JSAPI.h>
42#include <Ultralight/CAPI/CAPI_JSBuffer.h>
43#include <Ultralight/CAPI/CAPI_JSClass.h>
44#include <Ultralight/CAPI/CAPI_JSRuntime.h>
45#include <Ultralight/CAPI/CAPI_JSValue.h>
46#include <Ultralight/CAPI/CAPI_KeyEvent.h>
47#include <Ultralight/CAPI/CAPI_Logger.h>
48#include <Ultralight/CAPI/CAPI_MouseEvent.h>
49#include <Ultralight/CAPI/CAPI_Platform.h>
50#include <Ultralight/CAPI/CAPI_Renderer.h>
51#include <Ultralight/CAPI/CAPI_ScrollEvent.h>
52#include <Ultralight/CAPI/CAPI_GamepadEvent.h>
53#include <Ultralight/CAPI/CAPI_Session.h>
54#include <Ultralight/CAPI/CAPI_String.h>
55#include <Ultralight/CAPI/CAPI_Surface.h>
56#include <Ultralight/CAPI/CAPI_ThreadFactory.h>
57#include <Ultralight/CAPI/CAPI_URL.h>
58#include <Ultralight/CAPI/CAPI_View.h>
59
60#endif // ULTRALIGHT_CAPI_H
CAPI_AudioOutput.h
User-defined audio output interface.
CAPI_Bitmap.h
A container for pixel data.
CAPI_Buffer.h
A fixed-size container for raw byte data.
CAPI_Clipboard.h
User-defined clipboard interface.
CAPI_Color.h
An RGBA color value in a certain color space (with CSS parsing helpers).
CAPI_Config.h
Core configuration for the renderer.
CAPI_Editor.h
Text-editing interface for a View.
CAPI_FileSystem.h
User-defined file system interface.
CAPI_FontFile.h
Font file interface.
CAPI_FontLoader.h
User-defined font loader interface.
CAPI_GPUDriver.h
User-defined GPU driver interface.
CAPI_GamepadEvent.h
Gamepad event interface.
CAPI_Geometry.h
Geometry utilities.
CAPI_ImageSource.h
User-defined image source to display custom images on a web-page.
CAPI_JSAPI.h
A global JavaScript namespace attached to a View.
CAPI_JSBuffer.h
Functions for sharing raw binary memory with JavaScript through ArrayBuffers and typed arrays.
CAPI_JSClass.h
Native class definitions and instance wrappers for JavaScript.
CAPI_JSRuntime.h
JavaScript runtime functions for task posting, background work, and weak references.
CAPI_JSValue.h
JavaScript context and value handles for interacting with page script in C.
CAPI_KeyEvent.h
Key event interface.
CAPI_Logger.h
User-defined logging interface.
CAPI_MouseEvent.h
Mouse event interface.
CAPI_Platform.h
Global platform singleton, manages user-defined platform handlers.
CAPI_Renderer.h
Core renderer singleton for the library, coordinates all library functions.
CAPI_ScrollEvent.h
Scroll event interface.
CAPI_Session.h
Storage for a browsing session (cookies, local storage, etc.).
CAPI_String.h
Unicode string container (natively UTF-8).
CAPI_Surface.h
User-defined pixel buffer surface.
CAPI_ThreadFactory.h
User-defined factory for creating new threads.
CAPI_URL.h
Parsed web addresses for C.
CAPI_View.h
Web-page container rendered to an offscreen surface.
CAPI_Defines.h
Various defines and utility functions for the C API.