Ultralight C API

https://ultralig.ht/api/c/1_4_0
Admin
The Ultralight C API provides a portable interface over the Ultralight C++ API for easier usage from...
Tokens:250,281
Snippets:2,835
Trust Score:8.6
Update:4 days ago
Show doc for...
Tokens:
Raw
### ulStartRemoteInspectorServer

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h.html

Starts the remote inspector server.

```APIDOC
## ulStartRemoteInspectorServer

### Description
Start the remote inspector server.

### Function Signature
bool ulStartRemoteInspectorServer(ULRenderer renderer, const char *address, unsigned short port)

### Parameters
- **renderer** (ULRenderer) - The renderer instance.
- **address** (const char *) - The address to bind the server to.
- **port** (unsigned short) - The port to listen on.

### Returns
- **bool** - True if the server started successfully, false otherwise.
```

--------------------------------

### Create Renderer Example

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h.html

Demonstrates the sequence for configuring the platform handlers and creating the renderer instance.

```C
// Setup our config.
ULConfig config = ulCreateConfig();
// Use AppCore's font loader.
ulEnablePlatformFontLoader();
// Use AppCore's file system to load file:/// URLs from the OS.
ULString base_dir = ulCreateString("./assets/");
ulEnablePlatformFileSystem(base_dir);
ulDestroyString(base_dir);
// Create the renderer.
ULRenderer renderer = ulCreateRenderer(config);
// Destroy the config.
ulDestroyConfig(config);
// Set up Views here...
```

--------------------------------

### Run the App

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Call ulAppRun to start the main run loop of the application.

```c
#include <AppCore/CAPI.h>

int main() {
// Initialize app, window, overlay, etc. here...

ulAppRun(app);

ulDestroyApp(app);
return 0;
}
```

--------------------------------

### ulStartRemoteInspectorServer

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h_source.html

Starts the remote inspector server, allowing Views to be remotely inspected from another Ultralight instance.

```APIDOC
## ulStartRemoteInspectorServer

### Description
Start the remote inspector server. While the remote inspector is active, Views that are loaded into this renderer will be able to be remotely inspected from another Ultralight instance either locally (another app on same machine) or remotely (over the network) by navigating a View to: inspector://<ADDRESS>:<PORT>

### Parameters
- **renderer** (ULRenderer) - Required - The active renderer instance.
- **address** (const char*) - Required - The address for the server to listen on (eg, "127.0.0.1")
- **port** (unsigned short) - Required - The port for the server to listen on (eg, 9222)

### Returns
- **bool** - Returns whether the server started successfully or not.
```

--------------------------------

### ulAppGetMainMonitor

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the main monitor, which is never NULL.

```APIDOC
## ulAppGetMainMonitor

### Description
Gets the main monitor. This is never NULL. Monitor enumeration will be added later.

### Function Signature
ULMonitor ulAppGetMainMonitor(ULApp app);

### Parameters
- **app** (ULApp) - Required - The App instance.

### Return Value
Returns the main ULMonitor.
```

--------------------------------

### ulAppGetMainMonitor

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the main monitor (never NULL).

```APIDOC
## ulAppGetMainMonitor

### Description
Get the main monitor (this is never NULL).

### Signature
ULMonitor ulAppGetMainMonitor(ULApp app);

### Parameters
- **app** (ULApp) - The application.

### Return Value
ULMonitor - The main monitor.
```

--------------------------------

### ulStartRemoteInspectorServer

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h_source.html

Starts the remote inspector server, allowing debugging of the renderer from a remote client.

```APIDOC
## ulStartRemoteInspectorServer

### Description
Starts the remote inspector server.

### Function Signature
bool ulStartRemoteInspectorServer(ULRenderer renderer, const char *address, unsigned short port)

### Parameters
- **renderer** (ULRenderer) - Required - The active renderer instance.
- **address** (const char *) - Required - The address to bind the server to.
- **port** (unsigned short) - Required - The port to listen on.

### Returns
- **bool** - True if the server started successfully, false otherwise.
```

--------------------------------

### ulAppGetRenderer

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the underlying Renderer instance.

```APIDOC
## ulAppGetRenderer

### Description
Gets the underlying Renderer instance.

### Function Signature
ULRenderer ulAppGetRenderer(ULApp app);

### Parameters
- **app** (ULApp) - Required - The App instance.

### Return Value
Returns the ULRenderer instance.
```

--------------------------------

### ulWindowGetNativeHandle

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the underlying native window handle.

```APIDOC
## ulWindowGetNativeHandle

### Description
Gets the underlying native window handle.

### Function Signature
void * ulWindowGetNativeHandle(ULWindow window)

### Parameters
- **window** (ULWindow) - Required - The Window.

### Returns
- **void *** - The native window handle.
```

--------------------------------

### ulViewGetDeviceScale

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the device scale of the view, i.e., the amount to scale page units to screen pixels. For example, 1.0 is 100% zoom, 2.0 is 200% zoom.

```APIDOC
## ulViewGetDeviceScale

### Description
Gets the device scale of the view, i.e., the amount to scale page units to screen pixels. For example, 1.0 is 100% zoom, 2.0 is 200% zoom.

### Method
C Function

### Signature
double ulViewGetDeviceScale(ULView view);

### Parameters
- **view** (ULView) - Required - The view object.

### Returns
- **double** - The device scale.
```

--------------------------------

### JSObjectGetPropertyCallback

Source: https://ultralig.ht/api/c/1_4_0/_j_s_object_ref_8h_source.html

Callback invoked when getting a property's value. If this function returns NULL, the get request forwards to object's statically declared properties, then its parent class chain, then its prototype chain.

```APIDOC
## JSObjectGetPropertyCallback

### Description
Callback invoked when getting a property's value. If this function returns NULL, the get request forwards to object's statically declared properties, then its parent class chain (which includes the default object class), then its prototype chain.

### Signature
JSValueRef (*JSObjectGetPropertyCallback)(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef* exception);

### Parameters
- **ctx** (JSContextRef) - The execution context to use.
- **object** (JSObjectRef) - The JSObject to search for the property.
- **propertyName** (JSStringRef) - A JSString containing the name of the property to get.
- **exception** (JSValueRef*) - A pointer to a JSValueRef in which to return an exception, if any.

### Return Value
- **JSValueRef** - The property's value if object has the property, otherwise NULL.

### Example Declaration
JSValueRef GetProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef* exception);
```

--------------------------------

### Create the Renderer

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h_source.html

Demonstrates how to configure the renderer, enable platform handlers for fonts and file systems, and initialize the renderer instance.

```c
// Setup our config.
ULConfig config = ulCreateConfig();

// Use AppCore's font loader.
ulEnablePlatformFontLoader();

// Use AppCore's file system to load file:/// URLs from the OS.
ULString base_dir = ulCreateString("./assets/");
ulEnablePlatformFileSystem(base_dir);
ulDestroyString(base_dir);

// Create the renderer.
ULRenderer renderer = ulCreateRenderer(config);

// Destroy the config.
ulDestroyConfig(config);

// Set up Views here...
```

--------------------------------

### Creating a View

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Demonstrates how to initialize a View using a configuration object and clean up the configuration afterwards.

```c
// Create a ULViewConfig with default values
ULViewConfig view_config = ulCreateViewConfig();

// Create a View, 500 by 500 pixels in size, using the default Session
ULView view = ulCreateView(renderer, 500, 500, view_config, NULL);

// Clean up the ULViewConfig
ulDestroyViewConfig(view_config);
```

--------------------------------

### JSObjectGetProperty

Source: https://ultralig.ht/api/c/1_4_0/_j_s_object_ref_8h_source.html

Gets a property from an object.

```APIDOC
## JSObjectGetProperty

### Description
Gets a property from an object.

### Function Signature
JS_EXPORT JSValueRef JSObjectGetProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef* exception)

### Parameters
- **ctx** (JSContextRef) - Required - The execution context to use.
- **object** (JSObjectRef) - Required - The JSObject whose property you want to get.
- **propertyName** (JSStringRef) - Required - A JSString containing the property's name.
- **exception** (JSValueRef*) - Optional - A pointer to store an exception, if any. Pass NULL if not needed.

### Return Value
The property's value if object has the property, otherwise the undefined value.
```

--------------------------------

### Render Each Frame

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h_source.html

Example of the per-frame render logic used to notify the renderer of display refreshes.

```c
void displayFrame()
{
// Notify the renderer that the main display has refreshed. This will update animations,
// smooth scroll, and window.requestAnimationFrame() for all Views matching the display id.
```

--------------------------------

### Running the App Main Loop

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h.html

Demonstrates the basic lifecycle of an AppCore application, including starting the main run loop and destroying the app instance.

```C
#include <AppCore/CAPI.h>
int main() {
// Initialize app, window, overlay, etc. here...
ulAppRun(app);
ulDestroyApp(app);
return 0;
}
```

--------------------------------

### ulViewGetRenderTarget

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the RenderTarget for the View.

```APIDOC
## ulViewGetRenderTarget

### Description
Gets the RenderTarget for the View.

### Method
ULRenderTarget ulViewGetRenderTarget(ULView view)

### Parameters
- **view** (ULView) - The view to get the render target from.

### Returns
ULRenderTarget - The render target.
```

--------------------------------

### JSObjectGetPrototype

Source: https://ultralig.ht/api/c/1_4_0/_j_s_object_ref_8h_source.html

Gets an object's prototype.

```APIDOC
## JSObjectGetPrototype

### Description
Gets an object's prototype.

### Function Signature
JS_EXPORT JSValueRef JSObjectGetPrototype(JSContextRef ctx, JSObjectRef object)

### Parameters
- **ctx** (JSContextRef) - Required - The execution context to use.
- **object** (JSObjectRef) - Required - The JSObject whose prototype you want to get.

### Return Value
A JSValue that is the object's prototype.
```

--------------------------------

### Create the App singleton

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Call ulCreateApp to initialize the library and create the App singleton using default configuration and settings.

```c
// Create the App using default config and settings
ULApp app = ulCreateApp(NULL, NULL);
```

--------------------------------

### ulViewGetDisplayId

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the display id of the view.

```APIDOC
## ulViewGetDisplayId

### Description
Gets the display id of the view.

### Function Signature
unsigned int ulViewGetDisplayId(ULView view)

### Parameters
- **view** (ULView) - The view to query.

### Return Value
- **unsigned int** - The display id.
```

--------------------------------

### ulCreateApp

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates an App instance with the given settings. This is the entry point for initializing the AppCore application.

```APIDOC
## ulCreateApp

### Description
Creates an App instance with the given settings. This is the entry point for initializing the AppCore application.

### Function Signature
ULApp ulCreateApp(ULSettings settings)

### Parameters
- **settings** (ULSettings) - Required - The settings to use for the app.

### Returns
- **ULApp** - The created App instance.
```

--------------------------------

### ulEnablePlatformFileSystem

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Initializes the platform file system (needed for loading file:/// URLs) and sets it as the current FileSystem. Only needed if not calling ulCreateApp().

```APIDOC
## ulEnablePlatformFileSystem

### Description
This is only needed if you are not calling ulCreateApp(). Initializes the platform file system (needed for loading file:/// URLs) and sets it as the current FileSystem. You can specify a base directory path to resolve relative paths against.

### Signature
void ulEnablePlatformFileSystem(ULString base_dir);

### Parameters
- **base_dir** (ULString) - Base directory path to resolve relative paths against.

### Return Value
None.
```

--------------------------------

### ulViewGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the width of the view in pixels.

```APIDOC
## ulViewGetWidth

### Description
Get the width, in pixels.

### Function Signature
unsigned int ulViewGetWidth(ULView view)

### Parameters
- **view** (ULView) - The view to get the width from.

### Return Value
- **unsigned int** - The width in pixels.
```

--------------------------------

### ulViewGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the height of the view in pixels.

```APIDOC
## ulViewGetHeight

### Description
Get the height, in pixels.

### Function Signature
unsigned int ulViewGetHeight(ULView view)

### Parameters
- **view** (ULView) - The view to get the height from.

### Return Value
- **unsigned int** - The height in pixels.
```

--------------------------------

### ulViewGetURL

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the current URL of the view.

```APIDOC
## ulViewGetURL

### Description
Gets the current URL of the view.

### Method
ULString ulViewGetURL(ULView view)

### Parameters
- **view** (ULView) - The view to get the URL from.

### Returns
ULString - The current URL.
```

--------------------------------

### ulCreateApp

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates the App singleton.

```APIDOC
## ulCreateApp

### Description
Create the App singleton.

### Signature
ULApp ulCreateApp(ULSettings settings, ULConfig config);

### Parameters
- **settings** (ULSettings) - Settings for the app.
- **config** (ULConfig) - Configuration for the app.

### Return Value
ULApp - The created App.
```

--------------------------------

### ulViewGetTitle

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the current title of the view.

```APIDOC
## ulViewGetTitle

### Description
Gets the current title of the view.

### Method
ULString ulViewGetTitle(ULView view)

### Parameters
- **view** (ULView) - The view to get the title from.

### Returns
ULString - The current title.
```

--------------------------------

### ulViewGetDisplayId

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the display id of the view.

```APIDOC
## ulViewGetDisplayId

### Description
Gets the display id of the view.

### Method
C Function

### Signature
unsigned int ulViewGetDisplayId(ULView view);

### Parameters
- **view** (ULView) - Required - The view object.

### Returns
- **unsigned int** - The display id.
```

--------------------------------

### ulAppRun

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Runs the main loop.

```APIDOC
## ulAppRun

### Description
Runs the main loop.

### Function Signature
void ulAppRun(ULApp app);

### Parameters
- **app** (ULApp) - Required - The App instance.

### Return Value
None.
```

--------------------------------

### Renderer Update Loop Example

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h_source.html

A snippet showing the typical usage of refresh and render functions within an application loop.

```c
ulRefreshDisplay(renderer, 0);

// Render all Views as needed
ulRender(renderer);

// Each View will render to a
// - Pixel-Buffer Surface (ulViewGetSurface())
// or
// - GPU texture (ulViewGetRenderTarget())
// based on whether CPU or GPU rendering is used.
//
// You will need to display the image data here as needed.
}
}
```

--------------------------------

### ulViewGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the height of the view in pixels.

```APIDOC
## ulViewGetHeight

### Description
Gets the height of the view in pixels.

### Method
C Function

### Signature
unsigned int ulViewGetHeight(ULView view);

### Parameters
- **view** (ULView) - Required - The view object.

### Returns
- **unsigned int** - The height in pixels.
```

--------------------------------

### ulCreateOverlayWithView

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates a new Overlay, wrapping an existing View. The overlay will use the View's width and height. Each Overlay is essentially a View and an on-screen quad; you should create the Overlay then load content into the underlying View.

```APIDOC
## ulCreateOverlayWithView

### Description
Creates a new Overlay, wrapping an existing View. The overlay will use the View's width and height. Each Overlay is essentially a View and an on-screen quad; you should create the Overlay then load content into the underlying View.

### Function Signature
```c
ACExport ULOverlay ulCreateOverlayWithView(ULWindow window, ULView view, int x, int y);
```

### Parameters
- **window** (ULWindow) - The window to create the Overlay in. (we currently only support one window per application)
- **view** (ULView) - The View to wrap (will use its width and height).
- **x** (int) - The x-position (offset from the left of the Window), in pixels.
- **y** (int) - The y-position (offset from the top of the Window), in pixels.

### Return Value
- **ULOverlay** - The created overlay handle.
```

--------------------------------

### ulViewGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Gets the width of the view in pixels.

```APIDOC
## ulViewGetWidth

### Description
Gets the width of the view in pixels.

### Method
C Function

### Signature
unsigned int ulViewGetWidth(ULView view);

### Parameters
- **view** (ULView) - Required - The view object.

### Returns
- **unsigned int** - The width in pixels.
```

--------------------------------

### JSGlobalContextCopyName

Source: https://ultralig.ht/api/c/1_4_0/_j_s_context_ref_8h.html

Gets a copy of the name of a context.

```APIDOC
## JSGlobalContextCopyName

### Description
Gets a copy of the name of a context.

### Function Signature
JSStringRef JSGlobalContextCopyName(JSGlobalContextRef ctx)

### Parameters
- **ctx** (JSGlobalContextRef) - Required - The context whose name is to be copied.

### Return Value
A JSStringRef containing a copy of the context's name.

### Availability
macOS 10.10 and later, iOS 8.0 and later.
```

--------------------------------

### Using ImageSource in HTML

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___image_source_8h.html

Example of referencing an .imgsrc file within an HTML image tag.

```HTML
<img src="my_custom_image.imgsrc" />
```

--------------------------------

### ulCreateOverlay

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates a new Overlay in the specified window with the given dimensions and position. Each Overlay is essentially a View and an on-screen quad; you should create the Overlay then load content into the underlying View.

```APIDOC
## ulCreateOverlay

### Description
Creates a new Overlay in the specified window with the given dimensions and position. Each Overlay is essentially a View and an on-screen quad; you should create the Overlay then load content into the underlying View.

### Function Signature
```c
ACExport ULOverlay ulCreateOverlay(ULWindow window, unsigned int width, unsigned int height, int x, int y);
```

### Parameters
- **window** (ULWindow) - The window to create the Overlay in.
- **width** (unsigned int) - The width in pixels.
- **height** (unsigned int) - The height in pixels.
- **x** (int) - The x-position (offset from the left of the Window), in pixels.
- **y** (int) - The y-position (offset from the top of the Window), in pixels.

### Return Value
- **ULOverlay** - The created overlay handle.
```

--------------------------------

### ulMonitorGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the height of the monitor in pixels.

```APIDOC
## ulMonitorGetHeight

### Description
Gets the height of the monitor in pixels.

### Function Signature
unsigned int ulMonitorGetHeight(ULMonitor monitor)

### Parameters
- **monitor** (ULMonitor) - Required - The Monitor.

### Returns
- **unsigned int** - The height in pixels.
```

--------------------------------

### ulMonitorGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the width of the monitor in pixels.

```APIDOC
## ulMonitorGetWidth

### Description
Gets the width of the monitor in pixels.

### Function Signature
unsigned int ulMonitorGetWidth(ULMonitor monitor)

### Parameters
- **monitor** (ULMonitor) - Required - The Monitor.

### Returns
- **unsigned int** - The width in pixels.
```

--------------------------------

### Create an Overlay in a Window

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Call ulCreateOverlay to create an overlay instance within a window to display web-based content.

```c
ULOverlay overlay = ulCreateOverlay(window, 1024, 768, 0, 0);
```

--------------------------------

### ulBitmapGetFormat

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___bitmap_8h_source.html

Gets the pixel format of the bitmap.

```APIDOC
## ulBitmapGetFormat

### Description
Gets the pixel format of the bitmap.

### Function Signature
ULBitmapFormat ulBitmapGetFormat(ULBitmap bitmap)

### Parameters
- **bitmap** (ULBitmap) - Required - The bitmap to query.

### Returns
- **ULBitmapFormat** - The pixel format.
```

--------------------------------

### ulEnablePlatformFileSystem

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Enables the platform file system. Only needed if not calling ulCreateApp().

```APIDOC
## ulEnablePlatformFileSystem

### Description
Enables the platform file system. Only needed if not calling ulCreateApp().

### Function Signature
void ulEnablePlatformFileSystem(ULString base_dir)

### Parameters
- **base_dir** (ULString) - Required - The base directory for the file system.
```

--------------------------------

### ulOverlayShow

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Shows the overlay.

```APIDOC
## ulOverlayShow

### Description
Shows the overlay.

### Function Signature
void ulOverlayShow(ULOverlay overlay)

### Parameters
- **overlay** (ULOverlay) - Required - The Overlay to show.
```

--------------------------------

### ulBitmapGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___bitmap_8h_source.html

Gets the height of the bitmap in pixels.

```APIDOC
## ulBitmapGetHeight

### Description
Gets the height of the bitmap in pixels.

### Function Signature
unsigned int ulBitmapGetHeight(ULBitmap bitmap)

### Parameters
- **bitmap** (ULBitmap) - Required - The bitmap to query.

### Returns
- **unsigned int** - The height in pixels.
```

--------------------------------

### ulBitmapGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___bitmap_8h_source.html

Gets the width of the bitmap in pixels.

```APIDOC
## ulBitmapGetWidth

### Description
Gets the width of the bitmap in pixels.

### Function Signature
unsigned int ulBitmapGetWidth(ULBitmap bitmap)

### Parameters
- **bitmap** (ULBitmap) - Required - The bitmap to query.

### Returns
- **unsigned int** - The width in pixels.
```

--------------------------------

### ulCreateWindow

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates a new Window with the specified properties.

```APIDOC
## ulCreateWindow

### Description
Creates a new Window with the specified properties.

### Function Signature
ULWindow ulCreateWindow(ULMonitor monitor, unsigned int width, unsigned int height, bool fullscreen, unsigned int window_flags)

### Parameters
- **monitor** (ULMonitor) - Required - The monitor to create the window on.
- **width** (unsigned int) - Required - The width of the window in pixels.
- **height** (unsigned int) - Required - The height of the window in pixels.
- **fullscreen** (bool) - Required - Whether the window should be fullscreen.
- **window_flags** (unsigned int) - Required - Flags for window creation (see ULWindowFlags).

### Returns
- **ULWindow** - The created Window.
```

--------------------------------

### ulPlatformSetFileSystem

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___platform_8h.html

Sets a custom FileSystem implementation. The library uses this to load all file URLs (eg, file:///page.html). You can provide your own FileSystem implementation so that file assets are loaded from your own pipeline. Call this before ulCreateRenderer() or ulCreateApp().

```APIDOC
## ulPlatformSetFileSystem

### Description
Sets a custom FileSystem implementation. The library uses this to load all file URLs (eg, file:///page.html). You can provide the library with your own FileSystem implementation so that file assets are loaded from your own pipeline. You should call this before ulCreateRenderer() or ulCreateApp().

### Method
void ulPlatformSetFileSystem(ULFileSystem _file_system_)

### Parameters
- **_file_system_** (ULFileSystem) - Required - The custom file system implementation.

### Notes
- This is required to be defined before calling ulCreateRenderer().
- ulCreateApp() will use the default platform file system if you never call this. If you're not using ulCreateApp(), (eg, using ulCreateRenderer()) you can still use the default platform file system by calling ulEnablePlatformFileSystem().

### See Also
- <AppCore/CAPI.h>
```

--------------------------------

### ulOverlayGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the width of the overlay in pixels.

```APIDOC
## ulOverlayGetWidth

### Description
Gets the width of the overlay in pixels.

### Function Signature
unsigned int ulOverlayGetWidth(ULOverlay overlay)

### Parameters
- **overlay** (ULOverlay) - Required - The Overlay.

### Returns
- **unsigned int** - The width in pixels.
```

--------------------------------

### ulCreateSettings

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates a settings object with default values.

```APIDOC
## ulCreateSettings

### Description
Creates a settings object with default values.

### Function Signature
ULSettings ulCreateSettings()

### Returns
- **ULSettings** - The created settings object.
```

--------------------------------

### ulWindowGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the window height in pixels.

```APIDOC
## ulWindowGetHeight

### Description
Gets the window height in pixels.

### Function Signature
unsigned int ulWindowGetHeight(ULWindow window)

### Parameters
- **window** (ULWindow) - Required - The Window.

### Returns
- **unsigned int** - The height in pixels.
```

--------------------------------

### ulOverlayShow

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Shows the overlay, making it visible again.

```APIDOC
## ulOverlayShow

### Description
Show the overlay.

### Signature
void ulOverlayShow(ULOverlay overlay);

### Parameters
- **overlay** (ULOverlay) - The overlay to show.

### Return Value
None.
```

--------------------------------

### ulBitmapGetFormat

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___bitmap_8h_source.html

Gets the pixel format of the bitmap.

```APIDOC
## ulBitmapGetFormat

### Description
Gets the pixel format of the bitmap.

### Function Signature
ULBitmapFormat ulBitmapGetFormat(ULBitmap bitmap);

### Parameters
- **bitmap** (ULBitmap) - Required - The bitmap to query.

### Returns
- **ULBitmapFormat** - The pixel format.
```

--------------------------------

### ulBitmapGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___bitmap_8h_source.html

Gets the height of the bitmap in pixels.

```APIDOC
## ulBitmapGetHeight

### Description
Gets the height of the bitmap in pixels.

### Function Signature
unsigned int ulBitmapGetHeight(ULBitmap bitmap);

### Parameters
- **bitmap** (ULBitmap) - Required - The bitmap to query.

### Returns
- **unsigned int** - The height in pixels.
```

--------------------------------

### ulCreateWindow

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates a new Window on the specified monitor with given dimensions and flags.

```APIDOC
## ulCreateWindow

### Description
Creates a new Window on the specified monitor with given width, height, fullscreen flag, and window flags.

### Function Signature
ULWindow ulCreateWindow(ULMonitor monitor, unsigned int width, unsigned int height, bool fullscreen, unsigned int window_flags);

### Parameters
- **monitor** (ULMonitor) - Required - The monitor to create the Window on.
- **width** (unsigned int) - Required - The width in screen coordinates.
- **height** (unsigned int) - Required - The height in screen coordinates.
- **fullscreen** (bool) - Required - Whether the window is fullscreen.
- **window_flags** (unsigned int) - Required - Various window flags.

### Return Value
Returns the created ULWindow instance.
```

--------------------------------

### ulBitmapGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___bitmap_8h_source.html

Gets the width of the bitmap in pixels.

```APIDOC
## ulBitmapGetWidth

### Description
Gets the width of the bitmap in pixels.

### Function Signature
unsigned int ulBitmapGetWidth(ULBitmap bitmap);

### Parameters
- **bitmap** (ULBitmap) - Required - The bitmap to query.

### Returns
- **unsigned int** - The width in pixels.
```

--------------------------------

### Renderer Lifecycle Management

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h_source.html

Functions to initialize and clean up the Ultralight renderer instance.

```c
ULExport ULRenderer ulCreateRenderer(ULConfig config);

ULExport void ulDestroyRenderer(ULRenderer renderer);
```

--------------------------------

### ulWindowGetScale

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the DPI scale of a window.

```APIDOC
## ulWindowGetScale

### Description
Get the DPI scale of a window.

### Signature
double ulWindowGetScale(ULWindow window);

### Parameters
- **window** (ULWindow) - The window.

### Return Value
double - DPI scale.
```

--------------------------------

### ulCreateApp

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates the App singleton with given settings and config. Should only be created once per application lifetime.

```APIDOC
## ulCreateApp

### Description
Creates the App singleton. Pass NULL for settings or config to use defaults. Certain Config options may be overridden during creation (e.g., face_winding, device_scale_hint).

### Function Signature
ULApp ulCreateApp(ULSettings settings, ULConfig config);

### Parameters
- **settings** (ULSettings) - Optional - Settings to customize App runtime behavior. Can be NULL.
- **config** (ULConfig) - Optional - Config options for the Ultralight renderer. Can be NULL.

### Return Value
Returns the created ULApp instance.
```

--------------------------------

### ulWindowGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the window width in pixels.

```APIDOC
## ulWindowGetWidth

### Description
Get window width (in pixels).

### Signature
unsigned int ulWindowGetWidth(ULWindow window);

### Parameters
- **window** (ULWindow) - The window.

### Return Value
unsigned int - Width in pixels.
```

--------------------------------

### ulOverlayGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the height of the overlay in pixels.

```APIDOC
## ulOverlayGetHeight

### Description
Get the height (in pixels).

### Signature
unsigned int ulOverlayGetHeight(ULOverlay overlay);

### Parameters
- **overlay** (ULOverlay) - The overlay.

### Return Value
unsigned int - Height in pixels.
```

--------------------------------

### ulWindowShow

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Shows the window if it was previously hidden.

```APIDOC
## ulWindowShow

### Description
Shows the window if it was previously hidden.

### Function Signature
```c
ACExport void ulWindowShow(ULWindow window);
```

### Parameters
- **window** (ULWindow) - The window handle.

### Return Value
- **void** - This function does not return a value.
```

--------------------------------

### ulOverlayGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the height of the overlay in pixels.

```APIDOC
## ulOverlayGetHeight

### Description
Gets the height of the overlay in pixels.

### Function Signature
```c
ACExport unsigned int ulOverlayGetHeight(ULOverlay overlay);
```

### Parameters
- **overlay** (ULOverlay) - The overlay handle.

### Return Value
- **unsigned int** - The height in pixels.
```

--------------------------------

### ulWindowShow

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Shows the window if it was previously hidden.

```APIDOC
## ulWindowShow

### Description
Show the window (if it was previously hidden).

### Signature
void ulWindowShow(ULWindow window);

### Parameters
- **window** (ULWindow) - The window to show.

### Return Value
None.
```

--------------------------------

### ulOverlayGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the width of the overlay in pixels.

```APIDOC
## ulOverlayGetWidth

### Description
Gets the width of the overlay in pixels.

### Function Signature
```c
ACExport unsigned int ulOverlayGetWidth(ULOverlay overlay);
```

### Parameters
- **overlay** (ULOverlay) - The overlay handle.

### Return Value
- **unsigned int** - The width in pixels.
```

--------------------------------

### ulEnablePlatformFileSystem

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h.html

Enables the platform file system with a base directory.

```APIDOC
## ulEnablePlatformFileSystem

### Description
This is only needed if you are not calling ulCreateApp().

### Function Signature
void ulEnablePlatformFileSystem(ULString base_dir)

### Parameters
- **base_dir** (ULString) - Required - The base directory for the file system.
```

--------------------------------

### ulOverlayGetView

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the underlying View of an overlay.

```APIDOC
## ulOverlayGetView

### Description
Gets the underlying View of an overlay.

### Function Signature
```c
ACExport ULView ulOverlayGetView(ULOverlay overlay);
```

### Parameters
- **overlay** (ULOverlay) - The overlay handle.

### Return Value
- **ULView** - The underlying View handle.
```

--------------------------------

### ulCreateRenderer(ULConfig)

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h.html

Creates the core renderer singleton for the library. Must be called after setting up the Platform singleton and requires a ULFontLoader and ULFileSystem to be defined. Only one renderer should be created during the program's lifetime.

```APIDOC
## ulCreateRenderer(ULConfig)

### Description
Creates the core renderer singleton for the library. You should set up the Platform singleton (see CAPI_Platform.h) before calling this function. You do not need to call this if you're using ulCreateApp() from AppCore. You'll need to define a ULFontLoader and ULFileSystem within the Platform singleton or else this call will fail. You should only create one Renderer during the lifetime of your program.

### Method
Function

### Signature
ULRenderer ulCreateRenderer(ULConfig _config_)

### Parameters
- **config** (ULConfig) - Required - The configuration to use for the renderer.

### Returns
Returns the new renderer instance (ULRenderer).
```

--------------------------------

### ulWindowGetScale

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the DPI scale of a window.

```APIDOC
## ulWindowGetScale

### Description
Gets the DPI scale of a window.

### Function Signature
```c
ACExport double ulWindowGetScale(ULWindow window);
```

### Parameters
- **window** (ULWindow) - The window handle.

### Return Value
- **double** - The DPI scale of the window.
```

--------------------------------

### ulStartRemoteInspectorServer

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h.html

Starts the remote inspector server. While active, Views loaded into this renderer can be remotely inspected from another Ultralight instance by navigating a View to inspector://<ADDRESS>:<PORT>.

```APIDOC
## ulStartRemoteInspectorServer

### Description
Start the remote inspector server. While the remote inspector is active, Views that are loaded into this renderer will be able to be remotely inspected from another Ultralight instance either locally (another app on same machine) or remotely (over the network) by navigating a View to: inspector://<ADDRESS>:<PORT>

### Function Signature
bool ulStartRemoteInspectorServer(ULRenderer _renderer_, const char * _address_, unsigned short _port_)

### Parameters
- **renderer** (ULRenderer) - Required - The active renderer instance.
- **address** (const char *) - Required - The address for the server to listen on (eg, "127.0.0.1").
- **port** (unsigned short) - Required - The port for the server to listen on (eg, 9222).

### Returns
bool - Returns whether the server started successfully or not.
```

--------------------------------

### ULBeginLoadingCallback

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___view_8h_source.html

Callback type for when a frame begins loading.

```APIDOC
## ULBeginLoadingCallback

### Description
Callback type for when a frame begins loading.

### Function Signature
void(*) ULBeginLoadingCallback(void *user_data, ULView caller, unsigned long long frame_id, bool is_main_frame, ULString url)

### Parameters
- **user_data** (void *) - User-defined data.
- **caller** (ULView) - The view that triggered the callback.
- **frame_id** (unsigned long long) - The frame identifier.
- **is_main_frame** (bool) - Whether the frame is the main frame.
- **url** (ULString) - The URL of the frame.
```

--------------------------------

### ulWindowIsFullscreen

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets whether or not a window is fullscreen.

```APIDOC
## ulWindowIsFullscreen

### Description
Gets whether or not a window is fullscreen.

### Function Signature
```c
ACExport bool ulWindowIsFullscreen(ULWindow window);
```

### Parameters
- **window** (ULWindow) - The window handle.

### Return Value
- **bool** - True if the window is fullscreen, false otherwise.
```

--------------------------------

### Load web content into an Overlay

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Use the View instance associated with an Overlay to load web content.

```c
ULString url = ulCreateString("https://google.com");
ULView view = ulOverlayGetView(overlay);
ulViewLoadURL(view, url);
ulDestroyString(url);
```

--------------------------------

### ulWindowGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the window height in pixels.

```APIDOC
## ulWindowGetHeight

### Description
Gets the window height in pixels.

### Function Signature
```c
ACExport unsigned int ulWindowGetHeight(ULWindow window);
```

### Parameters
- **window** (ULWindow) - The window handle.

### Return Value
- **unsigned int** - The window height in pixels.
```

--------------------------------

### ulApplyProjection

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___g_p_u_driver_8h_source.html

Sets up an orthographic projection matrix with a given viewport width and height, optionally flipping the Y axis. This function is used to configure the projection for rendering.

```APIDOC
## ulApplyProjection

### Description
Sets up an orthographic projection matrix with a certain viewport width and height, optionally flipping the Y axis.

### Function Signature
ULMatrix4x4 ulApplyProjection(ULMatrix4x4 transform, float viewport_width, float viewport_height, bool flip_y)

### Parameters
- **transform** (ULMatrix4x4) - Required - The base transformation matrix.
- **viewport_width** (float) - Required - The width of the viewport.
- **viewport_height** (float) - Required - The height of the viewport.
- **flip_y** (bool) - Required - Whether to flip the Y axis.

### Return Value
- **ULMatrix4x4** - The resulting projection matrix.
```

--------------------------------

### ulWindowGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the window width in pixels.

```APIDOC
## ulWindowGetWidth

### Description
Gets the window width in pixels.

### Function Signature
```c
ACExport unsigned int ulWindowGetWidth(ULWindow window);
```

### Parameters
- **window** (ULWindow) - The window handle.

### Return Value
- **unsigned int** - The window width in pixels.
```

--------------------------------

### ulMonitorGetHeight

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the height of the monitor in pixels.

```APIDOC
## ulMonitorGetHeight

### Description
Gets the height of the monitor in pixels.

### Function Signature
unsigned int ulMonitorGetHeight(ULMonitor monitor);

### Parameters
- **monitor** (ULMonitor) - Required - The monitor.

### Return Value
Returns the height in pixels as an unsigned int.
```

--------------------------------

### Create a Window

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Call ulCreateWindow to create a window during the lifetime of the application.

```c
ULWindow window = ulCreateWindow(ulAppGetMainMonitor(app), 1024, 768, false,
kWindowFlags_Titled | kWindowFlags_Resizable);
```

--------------------------------

### ulMonitorGetWidth

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Gets the width of the monitor in pixels.

```APIDOC
## ulMonitorGetWidth

### Description
Gets the width of the monitor in pixels.

### Function Signature
unsigned int ulMonitorGetWidth(ULMonitor monitor);

### Parameters
- **monitor** (ULMonitor) - Required - The monitor.

### Return Value
Returns the width in pixels as an unsigned int.
```

--------------------------------

### JSRetainPtr() [1/5]

Source: https://ultralig.ht/api/c/1_4_0/class_j_s_retain_ptr.html

Default constructor for JSRetainPtr.

```APIDOC
## JSRetainPtr() [1/5]

### Description
Default constructor for JSRetainPtr.

### Method
JSRetainPtr

### Parameters
None.
```

--------------------------------

### Remote Inspector Server Configuration

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h_source.html

Starts the remote inspector server. The inspector can be accessed by navigating a View to the specified address and port.

```c
inspector://<ADDRESS>:<PORT>

ULExport bool ulStartRemoteInspectorServer(ULRenderer renderer, const char* address,
 unsigned short port);
```

--------------------------------

### JSObjectGetPrivate

Source: https://ultralig.ht/api/c/1_4_0/_j_s_object_ref_8h_source.html

Gets an object's private data.

```APIDOC
## JSObjectGetPrivate

### Description
Gets an object's private data.

### Function Signature
void * JSObjectGetPrivate(JSObjectRef object)

### Parameters
- **object** (JSObjectRef) - Required - The object whose private data is to be retrieved.

### Return Value
A void pointer to the private data, or NULL if the object has no private data.
```

--------------------------------

### ulCreateConfig

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___renderer_8h.html

Creates a configuration object with default values.

```C
ULConfig ulCreateConfig()
```

--------------------------------

### ulCreateOverlay

Source: https://ultralig.ht/api/c/1_4_0/_app_core_2_c_a_p_i_8h_source.html

Creates a new Overlay.

```APIDOC
## ulCreateOverlay

### Description
Create a new Overlay.

### Signature
ULOverlay ulCreateOverlay(ULWindow window, unsigned int width, unsigned int height, int x, int y);

### Parameters
- **window** (ULWindow) - The window to attach the overlay to.
- **width** (unsigned int) - Width in pixels.
- **height** (unsigned int) - Height in pixels.
- **x** (int) - X position in pixels.
- **y** (int) - Y position in pixels.

### Return Value
ULOverlay - The created overlay.
```

--------------------------------

### JSObjectGetGlobalContext

Source: https://ultralig.ht/api/c/1_4_0/_j_s_object_ref_private_8h.html

Gets the global context of a JavaScript object.

```APIDOC
## JSObjectGetGlobalContext

### Description
Gets the global context of a JavaScript object.

### Function Signature
JSGlobalContextRef JSObjectGetGlobalContext(JSObjectRef object)

### Parameters
- **object** (JSObjectRef) - The JSObject to get the global context for.

### Returns
- **JSGlobalContextRef** - The global context associated with the object.
```

--------------------------------

### ulApplyProjection

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___g_p_u_driver_8h.html

Sets up an orthographic projection matrix with a given viewport width and height, multiplies it by the provided transform, and returns the result. This is used to calculate the model-view projection matrix for vertex shaders using the current ULGPUState.

```APIDOC
## ulApplyProjection

### Description
Sets up an orthographic projection matrix with a certain viewport width and height, multiplies it by 'transform', and returns the result. This should be used to calculate the model-view projection matrix for the vertex shaders using the current ULGPUState. The 'flip_y' can be optionally used to flip the Y coordinate-space. (Usually flip_y == true for OpenGL)

### Function Signature
ULMatrix4x4 ulApplyProjection(ULMatrix4x4 _transform_, float _viewport_width_, float _viewport_height_, bool _flip_y_)

### Parameters
- **transform** (ULMatrix4x4) - Required - The transform matrix to multiply with the projection matrix.
- **viewport_width** (float) - Required - The width of the viewport.
- **viewport_height** (float) - Required - The height of the viewport.
- **flip_y** (bool) - Required - Whether to flip the Y coordinate-space.

### Return Value
Returns the resulting model-view projection matrix (ULMatrix4x4).
```

--------------------------------

### JSObjectGetPrivateProperty

Source: https://ultralig.ht/api/c/1_4_0/_j_s_object_ref_private_8h_source.html

Gets a private property from a JavaScript object.

```APIDOC
## JSObjectGetPrivateProperty

### Description
Gets a private property from an object.

### Function Signature
JSValueRef JSObjectGetPrivateProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName)

### Parameters
- **ctx** (JSContextRef) - The execution context to use.
- **object** (JSObjectRef) - The object from which to get the private property.
- **propertyName** (JSStringRef) - The name of the private property to get.

### Return Value
- **JSValueRef** - The value of the private property, or NULL if the property does not exist.
```

--------------------------------

### ULFileSystem

Source: https://ultralig.ht/api/c/1_4_0/_c_a_p_i___file_system_8h_source.html

User-defined file system interface. Implement each callback and pass an instance of this struct to ulPlatformSetFileSystem().

```APIDOC
## ULFileSystem

### Description
User-defined file system interface. You should implement each of these callbacks, then pass an instance of this struct containing your callbacks to ulPlatformSetFileSystem().

### Fields
- **file_exists** (ULFileSystemFileExistsCallback) - Callback to check if a file path exists.
- **get_file_mime_type** (ULFileSystemGetFileMimeTypeCallback) - Callback to get the MIME type of a file.
- **get_file_charset** (ULFileSystemGetFileCharsetCallback) - Callback to get the charset/encoding of a file.
- **open_file** (ULFileSystemOpenFileCallback) - Callback to open a file and map it to a buffer.
```

--------------------------------

### JSObjectGetProxyTarget

Source: https://ultralig.ht/api/c/1_4_0/_j_s_object_ref_private_8h.html

Gets the proxy target of a JavaScript object.

```APIDOC
## JSObjectGetProxyTarget

### Description
Gets the proxy target of a JavaScript object.

### Function Signature
JSObjectRef JSObjectGetProxyTarget(JSObjectRef object)

### Parameters
- **object** (JSObjectRef) - The JSObject to get the proxy target for.

### Returns
- **JSObjectRef** - The proxy target object, or NULL if the object is not a proxy.
```
Tokens:
Raw