Structs§
- C_App
- C_
Bitmap - C_
Buffer - C_
Config - C_
KeyEvent - C_
Monitor - C_
Mouse Event - C_
Overlay - C_
Renderer - C_
Scroll Event - C_
Session - C_
Settings - C_
String - C_
Surface - C_View
- C_
View Config - C_
Window - JSClass
Definition - @struct JSClassDefinition @abstract This structure contains properties and callbacks that define a type of object. All fields other than the version field are optional. Any pointer may be NULL. @field version The version number of this structure. The current version is 0. @field attributes A logically ORed set of JSClassAttributes to give to the class. @field className A null-terminated UTF8 string containing the class’s name. @field parentClass A JSClass to set as the class’s parent class. Pass NULL use the default object class. @field staticValues A JSStaticValue array containing the class’s statically declared value properties. Pass NULL to specify no statically declared value properties. The array must be terminated by a JSStaticValue whose name field is NULL. @field staticFunctions A JSStaticFunction array containing the class’s statically declared function properties. Pass NULL to specify no statically declared function properties. The array must be terminated by a JSStaticFunction whose name field is NULL. @field initialize The callback invoked when an object is first created. Use this callback to initialize the object. @field finalize The callback invoked when an object is finalized (prepared for garbage collection). Use this callback to release resources allocated for the object, and perform other cleanup. @field hasProperty The callback invoked when determining whether an object has a property. If this field is NULL, getProperty is called instead. The hasProperty callback enables optimization in cases where only a property’s existence needs to be known, not its value, and computing its value is expensive. @field getProperty The callback invoked when getting a property’s value. @field setProperty The callback invoked when setting a property’s value. @field deleteProperty The callback invoked when deleting a property. @field getPropertyNames The callback invoked when collecting the names of an object’s properties. @field callAsFunction The callback invoked when an object is called as a function. @field hasInstance The callback invoked when an object is used as the target of an ‘instanceof’ expression. @field callAsConstructor The callback invoked when an object is used as a constructor in a ‘new’ expression. @field convertToType The callback invoked when converting an object to a particular JavaScript type. @discussion The staticValues and staticFunctions arrays are the simplest and most efficient means for vending custom properties. Statically declared properties autmatically service requests like getProperty, setProperty, and getPropertyNames. Property access callbacks are required only to implement unusual properties, like array indexes, whose names are not known at compile-time.
- JSClass
Definition__ bindgen_ ty_ 1__ bindgen_ ty_ 1 - JSClass
Definition__ bindgen_ ty_ 1__ bindgen_ ty_ 2 - JSStatic
Function - @struct JSStaticFunction @abstract This structure describes a statically declared function property. @field name A null-terminated UTF8 string containing the property’s name. @field callAsFunction A JSObjectCallAsFunctionCallback to invoke when the property is called as a function. @field attributes A logically ORed set of JSPropertyAttributes to give to the property.
- JSStatic
Function Ex - JSStatic
Value - @struct JSStaticValue @abstract This structure describes a statically declared value property. @field name A null-terminated UTF8 string containing the property’s name. @field getProperty A JSObjectGetPropertyCallback to invoke when getting the property’s value. @field setProperty A JSObjectSetPropertyCallback to invoke when setting the property’s value. May be NULL if the ReadOnly attribute is set. @field attributes A logically ORed set of JSPropertyAttributes to give to the property.
- JSStatic
Value Ex - OpaqueJS
Class - OpaqueJS
Context - OpaqueJS
Context Group - OpaqueJS
Property Name Accumulator - OpaqueJS
Property Name Array - OpaqueJS
String - OpaqueJS
Value - ULClipboard
- ULCommand
- Command description.
- ULCommand
List - Command list, @see ULGPUDriverUpdateCommandList
- ULFile
System - ULGPU
Driver - ULGPU
State - GPU State description.
- ULIndex
Buffer - Vertex index buffer data.
- ULInt
Rect - ULLogger
- ULMatrix4x4
- Raw 4x4 matrix as an array of floats
- ULRect
- ULRender
Buffer - Render buffer description.
- ULRender
Target - ULSurface
Definition - ULVertex
Buffer - Vertex buffer data.
- ULVertex_
2f_ 4ub_ 2f - Vertex layout for path vertices.
- ULVertex_
2f_ 4ub_ 2f_ 2f_ 28f - Vertex layout for quad vertices.
- ULvec4
- 4-component float vector
Constants§
- JSC_
OBJC_ API_ ENABLED - JSType_
kJSType Boolean - JSType_
kJSType Null - JSType_
kJSType Number - JSType_
kJSType Object - JSType_
kJSType String - JSType_
kJSType Symbol - JSType_
kJSType Undefined - JSTyped
Array Type_ kJSTyped Array Type Array Buffer - JSTyped
Array Type_ kJSTyped Array Type Float32 Array - JSTyped
Array Type_ kJSTyped Array Type Float64 Array - JSTyped
Array Type_ kJSTyped Array Type Int8 Array - JSTyped
Array Type_ kJSTyped Array Type Int16 Array - JSTyped
Array Type_ kJSTyped Array Type Int32 Array - JSTyped
Array Type_ kJSTyped Array Type None - JSTyped
Array Type_ kJSTyped Array Type Uint8 Array - JSTyped
Array Type_ kJSTyped Array Type Uint8 Clamped Array - JSTyped
Array Type_ kJSTyped Array Type Uint16 Array - JSTyped
Array Type_ kJSTyped Array Type Uint32 Array - ULBitmap
Format_ kBitmap Format_ A8_ UNORM - Alpha channel only, 8-bits per pixel.
- ULBitmap
Format_ kBitmap Format_ BGRA8_ UNORM_ SRGB - Blue Green Red Alpha channels, 32-bits per pixel.
- ULCommand
Type_ kCommand Type_ Clear Render Buffer - ULCommand
Type_ kCommand Type_ Draw Geometry - ULCursor_
kCursor_ Alias - ULCursor_
kCursor_ Cell - ULCursor_
kCursor_ Column Resize - ULCursor_
kCursor_ Context Menu - ULCursor_
kCursor_ Copy - ULCursor_
kCursor_ Cross - ULCursor_
kCursor_ Custom - ULCursor_
kCursor_ East Panning - ULCursor_
kCursor_ East Resize - ULCursor_
kCursor_ East West Resize - ULCursor_
kCursor_ Grab - ULCursor_
kCursor_ Grabbing - ULCursor_
kCursor_ Hand - ULCursor_
kCursor_ Help - ULCursor_
kCursor_ IBeam - ULCursor_
kCursor_ Middle Panning - ULCursor_
kCursor_ Move - ULCursor_
kCursor_ NoDrop - ULCursor_
kCursor_ None - ULCursor_
kCursor_ North East Panning - ULCursor_
kCursor_ North East Resize - ULCursor_
kCursor_ North East South West Resize - ULCursor_
kCursor_ North Panning - ULCursor_
kCursor_ North Resize - ULCursor_
kCursor_ North South Resize - ULCursor_
kCursor_ North West Panning - ULCursor_
kCursor_ North West Resize - ULCursor_
kCursor_ North West South East Resize - ULCursor_
kCursor_ NotAllowed - ULCursor_
kCursor_ Pointer - ULCursor_
kCursor_ Progress - ULCursor_
kCursor_ RowResize - ULCursor_
kCursor_ South East Panning - ULCursor_
kCursor_ South East Resize - ULCursor_
kCursor_ South Panning - ULCursor_
kCursor_ South Resize - ULCursor_
kCursor_ South West Panning - ULCursor_
kCursor_ South West Resize - ULCursor_
kCursor_ Vertical Text - ULCursor_
kCursor_ Wait - ULCursor_
kCursor_ West Panning - ULCursor_
kCursor_ West Resize - ULCursor_
kCursor_ Zoom In - ULCursor_
kCursor_ Zoom Out - ULFace
Winding_ kFace Winding_ Clockwise - ULFace
Winding_ kFace Window_ Counter Clockwise - ULFont
Hinting_ kFont Hinting_ Monochrome - Strongest hinting algorithm– outputs only black/white glyphs. The result is usually unpleasant if the underlying TTF does not contain hints for this type of rendering.
- ULFont
Hinting_ kFont Hinting_ Normal - Default hinting algorithm– offers a good balance between sharpness and shape at smaller font sizes.
- ULFont
Hinting_ kFont Hinting_ Smooth - Lighter hinting algorithm– glyphs are slightly fuzzier but better resemble their original shape. This is achieved by snapping glyphs to the pixel grid only vertically which better preserves inter-glyph spacing.
- ULInvalid
File Handle - Handle used to denote an invalid file.
- ULKey
Event Type_ kKey Event Type_ Char - Character input event type. Use this when the OS generates text from a physical key being pressed (eg, WM_CHAR on Windows).
- ULKey
Event Type_ kKey Event Type_ KeyDown - Key-Down event type. (Does not trigger accelerator commands in WebCore)
- ULKey
Event Type_ kKey Event Type_ KeyUp - Key-Up event type. Use this when a physical key is released.
- ULKey
Event Type_ kKey Event Type_ RawKey Down - Raw Key-Down type. Use this when a physical key is pressed.
- ULLog
Level_ kLog Level_ Error - ULLog
Level_ kLog Level_ Info - ULLog
Level_ kLog Level_ Warning - ULMessage
Level_ kMessage Level_ Debug - ULMessage
Level_ kMessage Level_ Error - ULMessage
Level_ kMessage Level_ Info - ULMessage
Level_ kMessage Level_ Log - ULMessage
Level_ kMessage Level_ Warning - ULMessage
Source_ kMessage Source_ AppCache - ULMessage
Source_ kMessage Source_ CSS - ULMessage
Source_ kMessage Source_ ConsoleAPI - ULMessage
Source_ kMessage Source_ Content Blocker - ULMessage
Source_ kMessage Source_ JS - ULMessage
Source_ kMessage Source_ Network - ULMessage
Source_ kMessage Source_ Other - ULMessage
Source_ kMessage Source_ Rendering - ULMessage
Source_ kMessage Source_ Security - ULMessage
Source_ kMessage Source_ Storage - ULMessage
Source_ kMessage Source_ XML - ULMouse
Button_ kMouse Button_ Left - ULMouse
Button_ kMouse Button_ Middle - ULMouse
Button_ kMouse Button_ None - ULMouse
Button_ kMouse Button_ Right - ULMouse
Event Type_ kMouse Event Type_ Mouse Down - ULMouse
Event Type_ kMouse Event Type_ Mouse Moved - ULMouse
Event Type_ kMouse Event Type_ Mouse Up - ULScroll
Event Type_ kScroll Event Type_ Scroll ByPage - ULScroll
Event Type_ kScroll Event Type_ Scroll ByPixel - ULShader
Type_ kShader Type_ Fill - ULShader
Type_ kShader Type_ Fill Path - ULVertex
Buffer Format_ kVertex Buffer Format_ 2f_ 4ub_ 2f - ULVertex
Buffer Format_ kVertex Buffer Format_ 2f_ 4ub_ 2f_ 2f_ 28f - ULWindow
Flags_ kWindow Flags_ Borderless - ULWindow
Flags_ kWindow Flags_ Hidden - ULWindow
Flags_ kWindow Flags_ Maximizable - ULWindow
Flags_ kWindow Flags_ Resizable - ULWindow
Flags_ kWindow Flags_ Titled - kJSClass
Attribute NoAutomatic Prototype - kJSClass
Attribute None - kJSProperty
Attribute Dont Delete - kJSProperty
Attribute Dont Enum - kJSProperty
Attribute None - kJSProperty
Attribute Read Only
Statics§
- kJSClass
Definition ⚠Empty - @const kJSClassDefinitionEmpty @abstract A JSClassDefinition structure of the current version, filled with NULL pointers and having no attributes. @discussion Use this constant as a convenience when creating class definitions. For example, to create a class definition with only a finalize method:
Functions§
- JSCheck
Script ⚠Syntax - @function JSCheckScriptSyntax @abstract Checks for syntax errors in a string of JavaScript. @param ctx The execution context to use. @param script A JSString containing the script to check for syntax errors. @param sourceURL A JSString containing a URL for the script’s source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions. @param startingLineNumber An integer value specifying the script’s starting line number in the file located at sourceURL. This is only used when reporting exceptions. The value is one-based, so the first line is line 1 and invalid values are clamped to 1. @param exception A pointer to a JSValueRef in which to store a syntax error exception, if any. Pass NULL if you do not care to store a syntax error exception. @result true if the script is syntactically correct, otherwise false.
- JSClass
Create ⚠ - @function @abstract Creates a JavaScript class suitable for use with JSObjectMake. @param definition A JSClassDefinition that defines the class. @result A JSClass with the given definition. Ownership follows the Create Rule.
- JSClass
GetPrivate ⚠ - @function @abstract Retrieves the private data from a class reference, only possible with classes created with version 1000 (extended callbacks). @param jsClass The class to get the data from @result The private data on the class, or NULL, if not set @discussion Only classes with version 1000 (extended callbacks) can store private data, for other classes always NULL will always be returned.
- JSClass
Release ⚠ - @function @abstract Releases a JavaScript class. @param jsClass The JSClass to release.
- JSClass
Retain ⚠ - @function @abstract Retains a JavaScript class. @param jsClass The JSClass to retain. @result A JSClass that is the same as jsClass.
- JSClass
SetPrivate ⚠ - @function @abstract Sets the private data on a class, only possible with classes created with version 1000 (extended callbacks). @param jsClass The class to set the data on @param data A void* to set as the private data for the class @result true if the data has been set on the class, false if the class has not been created with version 1000 (extended callbacks) @discussion Only classes with version 1000 (extended callbacks) can store private data, for other classes the function always fails. The set pointer is not touched by the engine.
- JSContext
GetGlobal ⚠Context - @function @abstract Gets the global context of a JavaScript execution context. @param ctx The JSContext whose global context you want to get. @result ctx’s global context.
- JSContext
GetGlobal ⚠Object - @function @abstract Gets the global object of a JavaScript execution context. @param ctx The JSContext whose global object you want to get. @result ctx’s global object.
- JSContext
GetGroup ⚠ - @function @abstract Gets the context group to which a JavaScript execution context belongs. @param ctx The JSContext whose group you want to get. @result ctx’s group.
- JSContext
Group ⚠Create - @function @abstract Creates a JavaScript context group. @discussion A JSContextGroup associates JavaScript contexts with one another. Contexts in the same group may share and exchange JavaScript objects. Sharing and/or exchanging JavaScript objects between contexts in different groups will produce undefined behavior. When objects from the same context group are used in multiple threads, explicit synchronization is required.
- JSContext
Group ⚠Release - @function @abstract Releases a JavaScript context group. @param group The JSContextGroup to release.
- JSContext
Group ⚠Retain - @function @abstract Retains a JavaScript context group. @param group The JSContextGroup to retain. @result A JSContextGroup that is the same as group.
- JSEvaluate
Script ⚠ - @function JSEvaluateScript @abstract Evaluates a string of JavaScript. @param ctx The execution context to use. @param script A JSString containing the script to evaluate. @param thisObject The object to use as “this,” or NULL to use the global object as “this.” @param sourceURL A JSString containing a URL for the script’s source file. This is used by debuggers and when reporting exceptions. Pass NULL if you do not care to include source file information. @param startingLineNumber An integer value specifying the script’s starting line number in the file located at sourceURL. This is only used when reporting exceptions. The value is one-based, so the first line is line 1 and invalid values are clamped to 1. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The JSValue that results from evaluating script, or NULL if an exception is thrown.
- JSGarbage
Collect ⚠ - @function JSGarbageCollect @abstract Performs a JavaScript garbage collection. @param ctx The execution context to use. @discussion JavaScript values that are on the machine stack, in a register, protected by JSValueProtect, set as the global object of an execution context, or reachable from any such value will not be collected.
- JSGlobal
Context ⚠Copy Name - @function @abstract Gets a copy of the name of a context. @param ctx The JSGlobalContext whose name you want to get. @result The name for ctx. @discussion A JSGlobalContext’s name is exposed for remote debugging to make it easier to identify the context you would like to attach to.
- JSGlobal
Context ⚠Create - @function @abstract Creates a global JavaScript execution context. @discussion JSGlobalContextCreate allocates a global object and populates it with all the built-in JavaScript objects, such as Object, Function, String, and Array.
- JSGlobal
Context ⚠Create InGroup - @function @abstract Creates a global JavaScript execution context in the context group provided. @discussion JSGlobalContextCreateInGroup allocates a global object and populates it with all the built-in JavaScript objects, such as Object, Function, String, and Array. @param globalObjectClass The class to use when creating the global object. Pass NULL to use the default object class. @param group The context group to use. The created global context retains the group. Pass NULL to create a unique group for the context. @result A JSGlobalContext with a global object of class globalObjectClass and a context group equal to group.
- JSGlobal
Context ⚠Release - @function @abstract Releases a global JavaScript execution context. @param ctx The JSGlobalContext to release.
- JSGlobal
Context ⚠Retain - @function @abstract Retains a global JavaScript execution context. @param ctx The JSGlobalContext to retain. @result A JSGlobalContext that is the same as ctx.
- JSGlobal
Context ⚠SetName - @function @abstract Sets the remote debugging name for a context. @param ctx The JSGlobalContext that you want to name. @param name The remote debugging name to set on ctx.
- JSObject
Call ⚠AsConstructor - @function @abstract Calls an object as a constructor. @param ctx The execution context to use. @param object The JSObject to call as a constructor. @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of arguments to pass to the constructor. Pass NULL if argumentCount is 0. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The JSObject that results from calling object as a constructor, or NULL if an exception is thrown or object is not a constructor.
- JSObject
Call ⚠AsFunction - @function @abstract Calls an object as a function. @param ctx The execution context to use. @param object The JSObject to call as a function. @param thisObject The object to use as “this,” or NULL to use the global object as “this.” @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of arguments to pass to the function. Pass NULL if argumentCount is 0. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The JSValue that results from calling object as a function, or NULL if an exception is thrown or object is not a function.
- JSObject
Copy ⚠Property Names - @function @abstract Gets the names of an object’s enumerable properties. @param ctx The execution context to use. @param object The object whose property names you want to get. @result A JSPropertyNameArray containing the names object’s enumerable properties. Ownership follows the Create Rule.
- JSObject
Delete ⚠Property - @function @abstract Deletes a property from an object. @param ctx The execution context to use. @param object The JSObject whose property you want to delete. @param propertyName A JSString containing the property’s name. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result true if the delete operation succeeds, otherwise false (for example, if the property has the kJSPropertyAttributeDontDelete attribute set).
- JSObject
Delete ⚠Property ForKey - @function @abstract Deletes a property from an object using a JSValueRef as the property key. @param ctx The execution context to use. @param object The JSObject whose property you want to delete. @param propertyKey A JSValueRef containing the property key to use when looking up the property. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result true if the delete operation succeeds, otherwise false (for example, if the property has the kJSPropertyAttributeDontDelete attribute set). @discussion This function is the same as performing “delete object[propertyKey]” from JavaScript.
- JSObject
GetArray ⚠Buffer Byte Length - @function @abstract Returns the number of bytes in a JavaScript data object. @param ctx The execution context to use. @param object The JS Arary Buffer object whose length in bytes to return. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The number of bytes stored in the data object.
- JSObject
GetArray ⚠Buffer Bytes Ptr - @function @abstract Returns a pointer to the data buffer that serves as the backing store for a JavaScript Typed Array object. @param object The Array Buffer object whose internal backing store pointer to return. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A pointer to the raw data buffer that serves as object’s backing store or NULL if object is not an Array Buffer object. @discussion The pointer returned by this function is temporary and is not guaranteed to remain valid across JavaScriptCore API calls.
- JSObject
GetPrivate ⚠ - @function @abstract Gets an object’s private data. @param object A JSObject whose private data you want to get. @result A void* that is the object’s private data, if the object has private data, otherwise NULL.
- JSObject
GetProperty ⚠ - @function @abstract Gets a property from an object. @param ctx The execution context to use. @param object The JSObject whose property you want to get. @param propertyName A JSString containing the property’s name. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The property’s value if object has the property, otherwise the undefined value.
- JSObject
GetProperty ⚠AtIndex - @function @abstract Gets a property from an object by numeric index. @param ctx The execution context to use. @param object The JSObject whose property you want to get. @param propertyIndex An integer value that is the property’s name. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The property’s value if object has the property, otherwise the undefined value. @discussion Calling JSObjectGetPropertyAtIndex is equivalent to calling JSObjectGetProperty with a string containing propertyIndex, but JSObjectGetPropertyAtIndex provides optimized access to numeric properties.
- JSObject
GetProperty ⚠ForKey - @function @abstract Gets a property from an object using a JSValueRef as the property key. @param ctx The execution context to use. @param object The JSObject whose property you want to get. @param propertyKey A JSValueRef containing the property key to use when looking up the property. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The property’s value if object has the property key, otherwise the undefined value. @discussion This function is the same as performing “object[propertyKey]” from JavaScript.
- JSObject
GetPrototype ⚠ - @function @abstract Gets an object’s prototype. @param ctx The execution context to use. @param object A JSObject whose prototype you want to get. @result A JSValue that is the object’s prototype.
- JSObject
GetTyped ⚠Array Buffer - @function @abstract Returns the JavaScript Array Buffer object that is used as the backing of a JavaScript Typed Array object. @param ctx The execution context to use. @param object The JSObjectRef whose Typed Array type data pointer to obtain. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObjectRef with a JSTypedArrayType of kJSTypedArrayTypeArrayBuffer or NULL if object is not a Typed Array.
- JSObject
GetTyped ⚠Array Byte Length - @function @abstract Returns the byte length of a JavaScript Typed Array object. @param ctx The execution context to use. @param object The Typed Array object whose byte length to return. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The byte length of the Typed Array object or 0 if the object is not a Typed Array object.
- JSObject
GetTyped ⚠Array Byte Offset - @function @abstract Returns the byte offset of a JavaScript Typed Array object. @param ctx The execution context to use. @param object The Typed Array object whose byte offset to return. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The byte offset of the Typed Array object or 0 if the object is not a Typed Array object.
- JSObject
GetTyped ⚠Array Bytes Ptr - @function @abstract Returns a temporary pointer to the backing store of a JavaScript Typed Array object. @param ctx The execution context to use. @param object The Typed Array object whose backing store pointer to return. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A pointer to the raw data buffer that serves as object’s backing store or NULL if object is not a Typed Array object. @discussion The pointer returned by this function is temporary and is not guaranteed to remain valid across JavaScriptCore API calls.
- JSObject
GetTyped ⚠Array Length - @function @abstract Returns the length of a JavaScript Typed Array object. @param ctx The execution context to use. @param object The Typed Array object whose length to return. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The length of the Typed Array object or 0 if the object is not a Typed Array object.
- JSObject
HasProperty ⚠ - @function @abstract Tests whether an object has a given property. @param object The JSObject to test. @param propertyName A JSString containing the property’s name. @result true if the object has a property whose name matches propertyName, otherwise false.
- JSObject
HasProperty ⚠ForKey - @function @abstract Tests whether an object has a given property using a JSValueRef as the property key. @param object The JSObject to test. @param propertyKey A JSValueRef containing the property key to use when looking up the property. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result true if the object has a property whose name matches propertyKey, otherwise false. @discussion This function is the same as performing “propertyKey in object” from JavaScript.
- JSObject
IsConstructor ⚠ - @function @abstract Tests whether an object can be called as a constructor. @param ctx The execution context to use. @param object The JSObject to test. @result true if the object can be called as a constructor, otherwise false.
- JSObject
IsFunction ⚠ - @function @abstract Tests whether an object can be called as a function. @param ctx The execution context to use. @param object The JSObject to test. @result true if the object can be called as a function, otherwise false.
- JSObject
Make ⚠ - @function @abstract Creates a JavaScript object. @param ctx The execution context to use. @param jsClass The JSClass to assign to the object. Pass NULL to use the default object class. @param data A void* to set as the object’s private data. Pass NULL to specify no private data. @result A JSObject with the given class and private data. @discussion The default object class does not allocate storage for private data, so you must provide a non-NULL jsClass to JSObjectMake if you want your object to be able to store private data.
- JSObject
Make ⚠Array - @function @abstract Creates a JavaScript Array object. @param ctx The execution context to use. @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of data to populate the Array with. Pass NULL if argumentCount is 0. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObject that is an Array. @discussion The behavior of this function does not exactly match the behavior of the built-in Array constructor. Specifically, if one argument is supplied, this function returns an array with one element.
- JSObject
Make ⚠Array Buffer With Bytes NoCopy - @function @abstract Creates a JavaScript Array Buffer object from an existing pointer. @param ctx The execution context to use. @param bytes A pointer to the byte buffer to be used as the backing store of the Typed Array object. @param byteLength The number of bytes pointed to by the parameter bytes. @param bytesDeallocator The allocator to use to deallocate the external buffer when the Typed Array data object is deallocated. @param deallocatorContext A pointer to pass back to the deallocator. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObjectRef Array Buffer whose backing store is the same as the one pointed to by bytes or NULL if there was an error. @discussion If an exception is thrown during this function the bytesDeallocator will always be called.
- JSObject
Make ⚠Constructor - @function @abstract Convenience method for creating a JavaScript constructor. @param ctx The execution context to use. @param jsClass A JSClass that is the class your constructor will assign to the objects its constructs. jsClass will be used to set the constructor’s .prototype property, and to evaluate ‘instanceof’ expressions. Pass NULL to use the default object class. @param callAsConstructor A JSObjectCallAsConstructorCallback to invoke when your constructor is used in a ‘new’ expression. Pass NULL to use the default object constructor. @result A JSObject that is a constructor. The object’s prototype will be the default object prototype. @discussion The default object constructor takes no arguments and constructs an object of class jsClass with no private data.
- JSObject
Make ⚠Date - @function @abstract Creates a JavaScript Date object, as if by invoking the built-in Date constructor. @param ctx The execution context to use. @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of arguments to pass to the Date Constructor. Pass NULL if argumentCount is 0. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObject that is a Date.
- JSObject
Make ⚠Deferred Promise - @function @abstract Creates a JavaScript promise object by invoking the provided executor. @param ctx The execution context to use. @param resolve A pointer to a JSObjectRef in which to store the resolve function for the new promise. Pass NULL if you do not care to store the resolve callback. @param reject A pointer to a JSObjectRef in which to store the reject function for the new promise. Pass NULL if you do not care to store the reject callback. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObject that is a promise or NULL if an exception occurred.
- JSObject
Make ⚠Error - @function @abstract Creates a JavaScript Error object, as if by invoking the built-in Error constructor. @param ctx The execution context to use. @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of arguments to pass to the Error Constructor. Pass NULL if argumentCount is 0. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObject that is a Error.
- JSObject
Make ⚠Function - @function @abstract Creates a function with a given script as its body. @param ctx The execution context to use. @param name A JSString containing the function’s name. This will be used when converting the function to string. Pass NULL to create an anonymous function. @param parameterCount An integer count of the number of parameter names in parameterNames. @param parameterNames A JSString array containing the names of the function’s parameters. Pass NULL if parameterCount is 0. @param body A JSString containing the script to use as the function’s body. @param sourceURL A JSString containing a URL for the script’s source file. This is only used when reporting exceptions. Pass NULL if you do not care to include source file information in exceptions. @param startingLineNumber An integer value specifying the script’s starting line number in the file located at sourceURL. This is only used when reporting exceptions. The value is one-based, so the first line is line 1 and invalid values are clamped to 1. @param exception A pointer to a JSValueRef in which to store a syntax error exception, if any. Pass NULL if you do not care to store a syntax error exception. @result A JSObject that is a function, or NULL if either body or parameterNames contains a syntax error. The object’s prototype will be the default function prototype. @discussion Use this method when you want to execute a script repeatedly, to avoid the cost of re-parsing the script before each execution.
- JSObject
Make ⚠Function With Callback - @function @abstract Convenience method for creating a JavaScript function with a given callback as its implementation. @param ctx The execution context to use. @param name A JSString containing the function’s name. This will be used when converting the function to string. Pass NULL to create an anonymous function. @param callAsFunction The JSObjectCallAsFunctionCallback to invoke when the function is called. @result A JSObject that is a function. The object’s prototype will be the default function prototype.
- JSObject
Make ⚠RegExp - @function @abstract Creates a JavaScript RegExp object, as if by invoking the built-in RegExp constructor. @param ctx The execution context to use. @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of arguments to pass to the RegExp Constructor. Pass NULL if argumentCount is 0. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObject that is a RegExp.
- JSObject
Make ⚠Typed Array - @function @abstract Creates a JavaScript Typed Array object with the given number of elements. @param ctx The execution context to use. @param arrayType A value identifying the type of array to create. If arrayType is kJSTypedArrayTypeNone or kJSTypedArrayTypeArrayBuffer then NULL will be returned. @param length The number of elements to be in the new Typed Array. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObjectRef that is a Typed Array with all elements set to zero or NULL if there was an error.
- JSObject
Make ⚠Typed Array With Array Buffer - @function @abstract Creates a JavaScript Typed Array object from an existing JavaScript Array Buffer object. @param ctx The execution context to use. @param arrayType A value identifying the type of array to create. If arrayType is kJSTypedArrayTypeNone or kJSTypedArrayTypeArrayBuffer then NULL will be returned. @param buffer An Array Buffer object that should be used as the backing store for the created JavaScript Typed Array object. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObjectRef that is a Typed Array or NULL if there was an error. The backing store of the Typed Array will be buffer.
- JSObject
Make ⚠Typed Array With Array Buffer AndOffset - @function @abstract Creates a JavaScript Typed Array object from an existing JavaScript Array Buffer object with the given offset and length. @param ctx The execution context to use. @param arrayType A value identifying the type of array to create. If arrayType is kJSTypedArrayTypeNone or kJSTypedArrayTypeArrayBuffer then NULL will be returned. @param buffer An Array Buffer object that should be used as the backing store for the created JavaScript Typed Array object. @param byteOffset The byte offset for the created Typed Array. byteOffset should aligned with the element size of arrayType. @param length The number of elements to include in the Typed Array. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObjectRef that is a Typed Array or NULL if there was an error. The backing store of the Typed Array will be buffer.
- JSObject
Make ⚠Typed Array With Bytes NoCopy - @function @abstract Creates a JavaScript Typed Array object from an existing pointer. @param ctx The execution context to use. @param arrayType A value identifying the type of array to create. If arrayType is kJSTypedArrayTypeNone or kJSTypedArrayTypeArrayBuffer then NULL will be returned. @param bytes A pointer to the byte buffer to be used as the backing store of the Typed Array object. @param byteLength The number of bytes pointed to by the parameter bytes. @param bytesDeallocator The allocator to use to deallocate the external buffer when the JSTypedArrayData object is deallocated. @param deallocatorContext A pointer to pass back to the deallocator. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSObjectRef Typed Array whose backing store is the same as the one pointed to by bytes or NULL if there was an error. @discussion If an exception is thrown during this function the bytesDeallocator will always be called.
- JSObject
SetPrivate ⚠ - @function @abstract Sets a pointer to private data on an object. @param object The JSObject whose private data you want to set. @param data A void* to set as the object’s private data. @result true if object can store private data, otherwise false. @discussion The default object class does not allocate storage for private data. Only objects created with a non-NULL JSClass can store private data.
- JSObject
SetProperty ⚠ - @function @abstract Sets a property on an object. @param ctx The execution context to use. @param object The JSObject whose property you want to set. @param propertyName A JSString containing the property’s name. @param value A JSValueRef to use as the property’s value. @param attributes A logically ORed set of JSPropertyAttributes to give to the property. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception.
- JSObject
SetProperty ⚠AtIndex - @function @abstract Sets a property on an object by numeric index. @param ctx The execution context to use. @param object The JSObject whose property you want to set. @param propertyIndex The property’s name as a number. @param value A JSValue to use as the property’s value. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @discussion Calling JSObjectSetPropertyAtIndex is equivalent to calling JSObjectSetProperty with a string containing propertyIndex, but JSObjectSetPropertyAtIndex provides optimized access to numeric properties.
- JSObject
SetProperty ⚠ForKey - @function @abstract Sets a property on an object using a JSValueRef as the property key. @param ctx The execution context to use. @param object The JSObject whose property you want to set. @param propertyKey A JSValueRef containing the property key to use when looking up the property. @param value A JSValueRef to use as the property’s value. @param attributes A logically ORed set of JSPropertyAttributes to give to the property. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @discussion This function is the same as performing “object[propertyKey] = value” from JavaScript.
- JSObject
SetPrototype ⚠ - @function @abstract Sets an object’s prototype. @param ctx The execution context to use. @param object The JSObject whose prototype you want to set. @param value A JSValue to set as the object’s prototype.
- JSProperty
Name ⚠Accumulator AddName - @function @abstract Adds a property name to a JavaScript property name accumulator. @param accumulator The accumulator object to which to add the property name. @param propertyName The property name to add.
- JSProperty
Name ⚠Array GetCount - @function @abstract Gets a count of the number of items in a JavaScript property name array. @param array The array from which to retrieve the count. @result An integer count of the number of names in array.
- JSProperty
Name ⚠Array GetName AtIndex - @function @abstract Gets a property name at a given index in a JavaScript property name array. @param array The array from which to retrieve the property name. @param index The index of the property name to retrieve. @result A JSStringRef containing the property name.
- JSProperty
Name ⚠Array Release - @function @abstract Releases a JavaScript property name array. @param array The JSPropetyNameArray to release.
- JSProperty
Name ⚠Array Retain - @function @abstract Retains a JavaScript property name array. @param array The JSPropertyNameArray to retain. @result A JSPropertyNameArray that is the same as array.
- JSString
Create ⚠With Characters - @function @abstract Creates a JavaScript string from a buffer of Unicode characters. @param chars The buffer of Unicode characters to copy into the new JSString. @param numChars The number of characters to copy from the buffer pointed to by chars. @result A JSString containing chars. Ownership follows the Create Rule.
- JSString
Create ⚠WithUT F8CString - @function @abstract Creates a JavaScript string from a null-terminated UTF8 string. @param string The null-terminated UTF8 string to copy into the new JSString. @result A JSString containing string. Ownership follows the Create Rule.
- JSString
GetCharacters ⚠Ptr - @function @abstract Returns a pointer to the Unicode character buffer that serves as the backing store for a JavaScript string. @param string The JSString whose backing store you want to access. @result A pointer to the Unicode character buffer that serves as string’s backing store, which will be deallocated when string is deallocated.
- JSString
GetLength ⚠ - @function @abstract Returns the number of Unicode characters in a JavaScript string. @param string The JSString whose length (in Unicode characters) you want to know. @result The number of Unicode characters stored in string.
- JSString
GetMaximumUT ⚠F8CString Size - @function @abstract Returns the maximum number of bytes a JavaScript string will take up if converted into a null-terminated UTF8 string. @param string The JSString whose maximum converted size (in bytes) you want to know. @result The maximum number of bytes that could be required to convert string into a null-terminated UTF8 string. The number of bytes that the conversion actually ends up requiring could be less than this, but never more.
- JSString
GetUT ⚠F8CString - @function @abstract Converts a JavaScript string into a null-terminated UTF8 string, and copies the result into an external byte buffer. @param string The source JSString. @param buffer The destination byte buffer into which to copy a null-terminated UTF8 representation of string. On return, buffer contains a UTF8 string representation of string. If bufferSize is too small, buffer will contain only partial results. If buffer is not at least bufferSize bytes in size, behavior is undefined. @param bufferSize The size of the external buffer in bytes. @result The number of bytes written into buffer (including the null-terminator byte).
- JSString
IsEqual ⚠ - @function @abstract Tests whether two JavaScript strings match. @param a The first JSString to test. @param b The second JSString to test. @result true if the two strings match, otherwise false.
- JSString
IsEqual ⚠ToUT F8CString - @function @abstract Tests whether a JavaScript string matches a null-terminated UTF8 string. @param a The JSString to test. @param b The null-terminated UTF8 string to test. @result true if the two strings match, otherwise false.
- JSString
Release ⚠ - @function @abstract Releases a JavaScript string. @param string The JSString to release.
- JSString
Retain ⚠ - @function @abstract Retains a JavaScript string. @param string The JSString to retain. @result A JSString that is the same as string.
- JSValue
CreateJSON ⚠String - @function @abstract Creates a JavaScript string containing the JSON serialized representation of a JS value. @param ctx The execution context to use. @param value The value to serialize. @param indent The number of spaces to indent when nesting. If 0, the resulting JSON will not contains newlines. The size of the indent is clamped to 10 spaces. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSString with the result of serialization, or NULL if an exception is thrown.
- JSValue
GetType ⚠ - @function @abstract Returns a JavaScript value’s type. @param ctx The execution context to use. @param value The JSValue whose type you want to obtain. @result A value of type JSType that identifies value’s type.
- JSValue
GetTyped ⚠Array Type - @function @abstract Returns a JavaScript value’s Typed Array type. @param ctx The execution context to use. @param value The JSValue whose Typed Array type to return. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A value of type JSTypedArrayType that identifies value’s Typed Array type, or kJSTypedArrayTypeNone if the value is not a Typed Array object.
- JSValue
IsArray ⚠ - @function @abstract Tests whether a JavaScript value is an array. @param ctx The execution context to use. @param value The JSValue to test. @result true if value is an array, otherwise false.
- JSValue
IsBoolean ⚠ - @function @abstract Tests whether a JavaScript value’s type is the boolean type. @param ctx The execution context to use. @param value The JSValue to test. @result true if value’s type is the boolean type, otherwise false.
- JSValue
IsDate ⚠ - @function @abstract Tests whether a JavaScript value is a date. @param ctx The execution context to use. @param value The JSValue to test. @result true if value is a date, otherwise false.
- JSValue
IsEqual ⚠ - @function @abstract Tests whether two JavaScript values are equal, as compared by the JS == operator. @param ctx The execution context to use. @param a The first value to test. @param b The second value to test. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result true if the two values are equal, false if they are not equal or an exception is thrown.
- JSValue
IsInstance ⚠OfConstructor - @function @abstract Tests whether a JavaScript value is an object constructed by a given constructor, as compared by the JS instanceof operator. @param ctx The execution context to use. @param value The JSValue to test. @param constructor The constructor to test against. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result true if value is an object constructed by constructor, as compared by the JS instanceof operator, otherwise false.
- JSValue
IsNull ⚠ - @function @abstract Tests whether a JavaScript value’s type is the null type. @param ctx The execution context to use. @param value The JSValue to test. @result true if value’s type is the null type, otherwise false.
- JSValue
IsNumber ⚠ - @function @abstract Tests whether a JavaScript value’s type is the number type. @param ctx The execution context to use. @param value The JSValue to test. @result true if value’s type is the number type, otherwise false.
- JSValue
IsObject ⚠ - @function @abstract Tests whether a JavaScript value’s type is the object type. @param ctx The execution context to use. @param value The JSValue to test. @result true if value’s type is the object type, otherwise false.
- JSValue
IsObject ⚠OfClass - @function @abstract Tests whether a JavaScript value is an object with a given class in its class chain. @param ctx The execution context to use. @param value The JSValue to test. @param jsClass The JSClass to test against. @result true if value is an object and has jsClass in its class chain, otherwise false.
- JSValue
IsStrict ⚠Equal - @function @abstract Tests whether two JavaScript values are strict equal, as compared by the JS === operator. @param ctx The execution context to use. @param a The first value to test. @param b The second value to test. @result true if the two values are strict equal, otherwise false.
- JSValue
IsString ⚠ - @function @abstract Tests whether a JavaScript value’s type is the string type. @param ctx The execution context to use. @param value The JSValue to test. @result true if value’s type is the string type, otherwise false.
- JSValue
IsSymbol ⚠ - @function @abstract Tests whether a JavaScript value’s type is the symbol type. @param ctx The execution context to use. @param value The JSValue to test. @result true if value’s type is the symbol type, otherwise false.
- JSValue
IsUndefined ⚠ - @function @abstract Tests whether a JavaScript value’s type is the undefined type. @param ctx The execution context to use. @param value The JSValue to test. @result true if value’s type is the undefined type, otherwise false.
- JSValue
Make ⚠Boolean - @function @abstract Creates a JavaScript value of the boolean type. @param ctx The execution context to use. @param boolean The bool to assign to the newly created JSValue. @result A JSValue of the boolean type, representing the value of boolean.
- JSValue
Make ⚠FromJSON String - @function @abstract Creates a JavaScript value from a JSON formatted string. @param ctx The execution context to use. @param string The JSString containing the JSON string to be parsed. @result A JSValue containing the parsed value, or NULL if the input is invalid.
- JSValue
Make ⚠Null - @function @abstract Creates a JavaScript value of the null type. @param ctx The execution context to use. @result The unique null value.
- JSValue
Make ⚠Number - @function @abstract Creates a JavaScript value of the number type. @param ctx The execution context to use. @param number The double to assign to the newly created JSValue. @result A JSValue of the number type, representing the value of number.
- JSValue
Make ⚠String - @function @abstract Creates a JavaScript value of the string type. @param ctx The execution context to use. @param string The JSString to assign to the newly created JSValue. The newly created JSValue retains string, and releases it upon garbage collection. @result A JSValue of the string type, representing the value of string.
- JSValue
Make ⚠Symbol - @function @abstract Creates a JavaScript value of the symbol type. @param ctx The execution context to use. @param description A description of the newly created symbol value. @result A unique JSValue of the symbol type, whose description matches the one provided.
- JSValue
Make ⚠Undefined - @function @abstract Creates a JavaScript value of the undefined type. @param ctx The execution context to use. @result The unique undefined value.
- JSValue
Protect ⚠ - @function @abstract Protects a JavaScript value from garbage collection. @param ctx The execution context to use. @param value The JSValue to protect. @discussion Use this method when you want to store a JSValue in a global or on the heap, where the garbage collector will not be able to discover your reference to it.
- JSValue
ToBoolean ⚠ - @function @abstract Converts a JavaScript value to boolean and returns the resulting boolean. @param ctx The execution context to use. @param value The JSValue to convert. @result The boolean result of conversion.
- JSValue
ToNumber ⚠ - @function @abstract Converts a JavaScript value to number and returns the resulting number. @param ctx The execution context to use. @param value The JSValue to convert. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The numeric result of conversion, or NaN if an exception is thrown.
- JSValue
ToObject ⚠ - @function @abstract Converts a JavaScript value to object and returns the resulting object. @param ctx The execution context to use. @param value The JSValue to convert. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result The JSObject result of conversion, or NULL if an exception is thrown.
- JSValue
ToString ⚠Copy - @function @abstract Converts a JavaScript value to string and copies the result into a JavaScript string. @param ctx The execution context to use. @param value The JSValue to convert. @param exception A pointer to a JSValueRef in which to store an exception, if any. Pass NULL if you do not care to store an exception. @result A JSString with the result of conversion, or NULL if an exception is thrown. Ownership follows the Create Rule.
- JSValue
Unprotect ⚠ - @function @abstract Unprotects a JavaScript value from garbage collection. @param ctx The execution context to use. @param value The JSValue to unprotect. @discussion A value may be protected multiple times and must be unprotected an equal number of times before becoming eligible for garbage collection.
- ulApp
GetMain ⚠Monitor - Get the main monitor (this is never NULL).
- ulApp
GetRenderer ⚠ - Get the underlying Renderer instance.
- ulApp
IsRunning ⚠ - Whether or not the App is running.
- ulApp
Quit ⚠ - Quit the application.
- ulApp
Run ⚠ - Run the main loop.
- ulApp
SetUpdate ⚠Callback - Set a callback for whenever the App updates. You should update all app logic here.
- ulApply
Projection ⚠ - Sets up an orthographic projection matrix with a certain viewport width and height, multiplies it by ‘transform’, and returns the result.
- ulBitmap
Erase ⚠ - Reset bitmap pixels to 0.
- ulBitmap
GetBpp ⚠ - Get the bytes per pixel.
- ulBitmap
GetFormat ⚠ - Get the pixel format.
- ulBitmap
GetHeight ⚠ - Get the height in pixels.
- ulBitmap
GetRow ⚠Bytes - Get the number of bytes per row.
- ulBitmap
GetSize ⚠ - Get the size in bytes of the underlying pixel buffer.
- ulBitmap
GetWidth ⚠ - Get the width in pixels.
- ulBitmap
IsEmpty ⚠ - Whether or not this bitmap is empty.
- ulBitmap
Lock ⚠Pixels - Lock pixels for reading/writing, returns pointer to pixel buffer.
- ulBitmap
Owns ⚠Pixels - Whether or not this bitmap owns its own pixel buffer.
- ulBitmap
RawPixels ⚠ - Get raw pixel buffer– you should only call this if Bitmap is already locked.
- ulBitmap
Surface ⚠GetBitmap - Get the underlying Bitmap from the default Surface.
- ulBitmap
Swap ⚠RedBlue Channels - This converts a BGRA bitmap to RGBA bitmap and vice-versa by swapping the red and blue channels.
- ulBitmap
Unlock ⚠Pixels - Unlock pixels after locking.
- ulBitmap
WritePNG ⚠ - Write bitmap to a PNG on disk.
- ulConfig
SetAnimation ⚠Timer Delay - Set the amount of time to wait before triggering another repaint when a CSS animation is active. (Default = 1.0 / 60.0)
- ulConfig
SetCache ⚠Path - Set the file path to a writable directory that will be used to store cookies, cached resources, and other persistent data.
- ulConfig
SetFace ⚠Winding - The winding order for front-facing triangles. @see FaceWinding
- ulConfig
SetFont ⚠Gamma - The gamma to use when compositing font glyphs, change this value to adjust contrast (Adobe and Apple prefer 1.8, others may prefer 2.2). (Default = 1.8)
- ulConfig
SetFont ⚠Hinting - The hinting algorithm to use when rendering fonts. (Default = kFontHinting_Normal) @see ULFontHinting
- ulConfig
SetForce ⚠Repaint - Set whether or not we should continuously repaint any Views or compositor layers, regardless if they are dirty or not. This is mainly used to diagnose painting/shader issues. (Default = False)
- ulConfig
SetMemory ⚠Cache Size - Set the size of WebCore’s memory cache for decoded images, scripts, and other assets in bytes. (Default = 64 * 1024 * 1024)
- ulConfig
SetMin ⚠Large Heap Size - The minimum size of large VM heaps in JavaScriptCore. Set this to a lower value to make these heaps start with a smaller initial value.
- ulConfig
SetMin ⚠Small Heap Size - The minimum size of small VM heaps in JavaScriptCore. Set this to a lower value to make these heaps start with a smaller initial value.
- ulConfig
SetOverrideRAM ⚠Size - JavaScriptCore tries to detect the system’s physical RAM size to set reasonable allocation limits. Set this to anything other than 0 to override the detected value. Size is in bytes.
- ulConfig
SetPage ⚠Cache Size - Set the number of pages to keep in the cache. (Default = 0)
- ulConfig
SetRecycle ⚠Delay - The amount of time (in seconds) to wait before running the recycler (will attempt to return excess memory back to the system). (Default = 4.0)
- ulConfig
SetScroll ⚠Timer Delay - When a smooth scroll animation is active, the amount of time (in seconds) to wait before triggering another repaint. Default is 60 Hz.
- ulConfig
SetUser ⚠Stylesheet - Set user stylesheet (CSS) (Default = Empty).
- ulCreate
App ⚠ - Create the App singleton.
- ulCreate
Bitmap ⚠ - Create bitmap with certain dimensions and pixel format.
- ulCreate
Bitmap ⚠From Copy - Create bitmap from copy.
- ulCreate
Bitmap ⚠From Pixels - Create bitmap from existing pixel buffer. @see Bitmap for help using this function.
- ulCreate
Config ⚠ - Create config with default values (see <Ultralight/platform/Config.h>).
- ulCreate
Empty ⚠Bitmap - Create empty bitmap.
- ulCreate
KeyEvent ⚠ - Create a key event, @see KeyEvent for help with the following parameters.
- ulCreate
Mouse ⚠Event - Create a mouse event, @see MouseEvent for help using this function.
- ulCreate
Overlay ⚠ - Create a new Overlay.
- ulCreate
Overlay ⚠With View - Create a new Overlay, wrapping an existing View.
- ulCreate
Renderer ⚠ - Create the Ultralight Renderer directly.
- ulCreate
Scroll ⚠Event - Create a scroll event, @see ScrollEvent for help using this function.
- ulCreate
Session ⚠ - Create a Session to store local data in (such as cookies, local storage, application cache, indexed db, etc).
- ulCreate
Settings ⚠ - Create settings with default values (see <AppCore/App.h>).
- ulCreate
String ⚠ - Create string from null-terminated ASCII C-string.
- ulCreate
String ⚠From Copy - Create string from copy of existing string.
- ulCreate
StringUT ⚠F8 - Create string from UTF-8 buffer.
- ulCreate
StringUT ⚠F16 - Create string from UTF-16 buffer.
- ulCreate
View ⚠ - Create a View with certain size (in pixels).
- ulCreate
View ⚠Config - Create view configuration with default values (see <Ultralight/platform/View.h>).
- ulCreate
Window ⚠ - Create a new Window.
- ulDefault
Session ⚠ - Get the default session (persistent session named “default”).
- ulDestroy
App ⚠ - Destroy the App instance.
- ulDestroy
Bitmap ⚠ - Destroy a bitmap (you should only destroy Bitmaps you have explicitly created via one of the creation functions above.
- ulDestroy
Config ⚠ - Destroy config.
- ulDestroy
KeyEvent ⚠ - Destroy a key event.
- ulDestroy
Mouse ⚠Event - Destroy a mouse event.
- ulDestroy
Overlay ⚠ - Destroy an overlay.
- ulDestroy
Renderer ⚠ - Destroy the renderer.
- ulDestroy
Scroll ⚠Event - Destroy a scroll event.
- ulDestroy
Session ⚠ - Destroy a Session.
- ulDestroy
Settings ⚠ - Destroy settings.
- ulDestroy
String ⚠ - Destroy string (you should destroy any strings you explicitly Create).
- ulDestroy
View ⚠ - Destroy a View.
- ulDestroy
View ⚠Config - Destroy view configuration.
- ulDestroy
Window ⚠ - Destroy a Window.
- ulEnable
Default ⚠Logger - This is only needed if you are not calling ulCreateApp().
- ulEnable
Platform ⚠File System - This is only needed if you are not calling ulCreateApp().
- ulEnable
Platform ⚠Font Loader - This is only needed if you are not calling ulCreateApp().
- ulInt
Rect ⚠IsEmpty - Whether or not a ULIntRect is empty (all members equal to 0)
- ulInt
Rect ⚠Make Empty - Create an empty ULIntRect (all members equal to 0)
- ulLog
Memory ⚠Usage - Print detailed memory usage statistics to the log. (@see ulPlatformSetLogger)
- ulMonitor
GetHeight ⚠ - Get the height of the monitor (in pixels).
- ulMonitor
GetScale ⚠ - Get the monitor’s DPI scale (1.0 = 100%).
- ulMonitor
GetWidth ⚠ - Get the width of the monitor (in pixels).
- ulOverlay
Focus ⚠ - Grant this overlay exclusive keyboard focus.
- ulOverlay
GetHeight ⚠ - Get the height (in pixels).
- ulOverlay
GetView ⚠ - Get the underlying View.
- ulOverlay
GetWidth ⚠ - Get the width (in pixels).
- ulOverlay
GetX ⚠ - Get the x-position (offset from the left of the Window), in pixels.
- ulOverlay
GetY ⚠ - Get the y-position (offset from the top of the Window), in pixels.
- ulOverlay
HasFocus ⚠ - Whether or not an overlay has keyboard focus.
- ulOverlay
Hide ⚠ - Hide the overlay (will no longer be drawn).
- ulOverlay
IsHidden ⚠ - Whether or not the overlay is hidden (not drawn).
- ulOverlay
Move ⚠To - Move the overlay to a new position (in pixels).
- ulOverlay
Resize ⚠ - Resize the overlay (and underlying View), dimensions should be specified in pixels.
- ulOverlay
Show ⚠ - Show the overlay.
- ulOverlay
Unfocus ⚠ - Remove keyboard focus.
- ulPlatform
SetClipboard ⚠ - Set a custom Clipboard implementation.
- ulPlatform
SetFile ⚠System - Set a custom FileSystem implementation.
- ulPlatform
SetGPU ⚠Driver - Set a custom GPUDriver implementation.
- ulPlatform
SetLogger ⚠ - Set a custom Logger implementation.
- ulPlatform
SetSurface ⚠Definition - Set a custom Surface implementation.
- ulPurge
Memory ⚠ - Attempt to release as much memory as possible. Don’t call this from any callbacks or driver code.
- ulRect
IsEmpty ⚠ - Whether or not a ULRect is empty (all members equal to 0)
- ulRect
Make ⚠Empty - Create an empty ULRect (all members equal to 0)
- ulRender⚠
- Render all active Views.
- ulSession
GetDisk ⚠Path - The disk path to write to (used by persistent sessions only).
- ulSession
GetId ⚠ - Unique numeric Id for the session.
- ulSession
GetName ⚠ - Unique name identifying the session (used for unique disk path).
- ulSession
IsPersistent ⚠ - Whether or not is persistent (backed to disk).
- ulSettings
SetApp ⚠Name - Set the name of this app.
- ulSettings
SetDeveloper ⚠Name - Set the name of the developer of this app.
- ulSettings
SetFile ⚠System Path - Set the root file path for our file system, you should set this to the relative path where all of your app data is.
- ulSettings
SetForceCPU ⚠Renderer - We try to use the GPU renderer when a compatible GPU is detected.
- ulSettings
SetLoad ⚠Shaders From File System - Set whether or not we should load and compile shaders from the file system (eg, from the /shaders/ path, relative to file_system_path).
- ulString
AssignC ⚠String - Replaces the contents of ‘str’ with the contents of a C-string.
- ulString
Assign ⚠String - Replaces the contents of ‘str’ with the contents of ‘new_str’
- ulString
GetData ⚠ - Get internal UTF-16 buffer data.
- ulString
GetLength ⚠ - Get length in UTF-16 characters.
- ulString
IsEmpty ⚠ - Whether this string is empty or not.
- ulSurface
Clear ⚠Dirty Bounds - Clear the dirty bounds.
- ulSurface
GetDirty ⚠Bounds - Get the dirty bounds.
- ulSurface
GetHeight ⚠ - Height (in pixels).
- ulSurface
GetRow ⚠Bytes - Number of bytes between rows (usually width * 4)
- ulSurface
GetSize ⚠ - Size in bytes.
- ulSurface
GetUser ⚠Data - Get the underlying user data pointer (this is only valid if you have set a custom surface implementation via ulPlatformSetSurfaceDefinition).
- ulSurface
GetWidth ⚠ - Width (in pixels).
- ulSurface
Lock ⚠Pixels - Lock the pixel buffer and get a pointer to the beginning of the data for reading/writing.
- ulSurface
Resize ⚠ - Resize the pixel buffer to a certain width and height (both in pixels).
- ulSurface
SetDirty ⚠Bounds - Set the dirty bounds to a certain value.
- ulSurface
Unlock ⚠Pixels - Unlock the pixel buffer.
- ulUpdate⚠
- Update timers and dispatch internal callbacks (JavaScript and network).
- ulVersion
Major ⚠ - Get the numeric major version of the library.
- ulVersion
Minor ⚠ - Get the numeric minor version of the library.
- ulVersion
Patch ⚠ - Get the numeric patch version of the library.
- ulVersion
String ⚠ - Get the version string of the library in MAJOR.MINOR.PATCH format.
- ulView
CanGo ⚠Back - Check if can navigate backwards in history.
- ulView
CanGo ⚠Forward - Check if can navigate forwards in history.
- ulView
Config ⚠SetEnable Images - Set whether images should be enabled (Default = True).
- ulView
Config ⚠SetEnable Java Script - Set whether JavaScript should be eanbled (Default = True).
- ulView
Config ⚠SetFont Family Fixed - Set default font-family to use for fixed fonts, eg
and
(Default = Courier New). - ulView
Config ⚠SetFont Family Sans Serif - Set default font-family to use for sans-serif fonts (Default = Arial).
- ulView
Config ⚠SetFont Family Serif - Set default font-family to use for serif fonts (Default = Times New Roman).
- ulView
Config ⚠SetFont Family Standard - Set default font-family to use (Default = Times New Roman).
- ulView
Config ⚠SetInitial Device Scale - Set the amount that the application DPI has been scaled, used for scaling device coordinates to pixels and oversampling raster shapes (Default = 1.0).
- ulView
Config ⚠SetInitial Focus - ulView
Config ⚠SetIs Accelerated - When enabled, the View will be rendered to an offscreen GPU texture using the GPU driver set in ulPlatformSetGPUDriver. You can fetch details for the texture via ulViewGetRenderTarget.
- ulView
Config ⚠SetIs Transparent - Set whether images should be enabled (Default = True).
- ulView
Config ⚠SetUser Agent - Set user agent string (See <Ultralight/platform/Config.h> for the default).
- ulView
Create ⚠Inspector View - Create an inspector for this View, this is useful for debugging and inspecting pages locally. This will only succeed if you have the inspector assets in your filesystem– the inspector will look for file:///inspector/Main.html when it loads.
- ulView
Evaluate ⚠Script - Evaluate a string of JavaScript and return result.
- ulView
Fire ⚠KeyEvent - Fire a keyboard event.
- ulView
Fire ⚠Mouse Event - Fire a mouse event.
- ulView
Fire ⚠Scroll Event - Fire a scroll event.
- ulView
Focus ⚠ - Give focus to the View.
- ulView
GetHeight ⚠ - Get the height, in pixels.
- ulView
GetNeeds ⚠Paint - Whether or not a view should be painted during the next call to ulRender.
- ulView
GetRender ⚠Target - Get the RenderTarget for the View.
- ulView
GetSurface ⚠ - Get the Surface for the View (native pixel buffer container).
- ulView
GetTitle ⚠ - Get current title.
- ulView
GetURL ⚠ - Get current URL.
- ulView
GetWidth ⚠ - Get the width, in pixels.
- ulView
GoBack ⚠ - Navigate backwards in history.
- ulView
GoForward ⚠ - Navigate forwards in history.
- ulView
GoTo ⚠History Offset - Navigate to arbitrary offset in history.
- ulView
HasFocus ⚠ - Whether or not the View has focus.
- ulView
HasInput ⚠Focus - Whether or not the View has an input element with visible keyboard focus (indicated by a blinking caret).
- ulView
IsLoading ⚠ - Check if main frame is loading.
- ulView
LoadHTML ⚠ - Load a raw string of HTML.
- ulView
LoadURL ⚠ - Load a URL into main frame.
- ulView
LockJS ⚠Context - Acquire the page’s JSContext for use with JavaScriptCore API.
- ulView
Reload ⚠ - Reload current page.
- ulView
Resize ⚠ - Resize view to a certain width and height (in pixels).
- ulView
SetAdd ⚠Console Message Callback - Set callback for when a message is added to the console (useful for JavaScript / network errors and debugging).
- ulView
SetBegin ⚠Loading Callback - Set callback for when the page begins loading a new URL into a frame.
- ulView
SetChange ⚠Cursor Callback - Set callback for when the mouse cursor changes.
- ulView
SetChange ⚠Title Callback - Set callback for when the page title changes.
- ulView
SetChange ⚠Tooltip Callback - Set callback for when the tooltip changes (usually result of a mouse hover).
- ulView
SetChangeURL ⚠Callback - Set callback for when the page URL changes.
- ulView
SetCreate ⚠Child View Callback - Set callback for when the page wants to create a new View.
- ulView
SetDOM ⚠Ready Callback - Set callback for when all JavaScript has been parsed and the document is ready.
- ulView
SetFail ⚠Loading Callback - Set callback for when an error occurs while loading a URL into a frame.
- ulView
SetFinish ⚠Loading Callback - Set callback for when the page finishes loading a URL into a frame.
- ulView
SetNeeds ⚠Paint - Set whether or not a view should be repainted during the next call to ulRender.
- ulView
SetUpdate ⚠History Callback - Set callback for when the history (back/forward state) is modified.
- ulView
SetWindow ⚠Object Ready Callback - Set callback for when the JavaScript window object is reset for a new page load.
- ulView
Stop ⚠ - Stop all page loads.
- ulView
Unfocus ⚠ - Remove focus from the View and unfocus any focused input elements.
- ulView
UnlockJS ⚠Context - Unlock the page’s JSContext after a previous call to ulViewLockJSContext().
- ulWindow
Close ⚠ - Close a window.
- ulWindow
GetHeight ⚠ - Get window height (in pixels).
- ulWindow
GetNative ⚠Handle - Get the underlying native window handle.
- ulWindow
GetPositionX ⚠ - Get the x-position of the window (in screen coordinates) relative to the top-left of the monitor area.
- ulWindow
GetPositionY ⚠ - Get the y-position of the window (in screen coordinates) relative to the top-left of the monitor area.
- ulWindow
GetScale ⚠ - Get the DPI scale of a window.
- ulWindow
GetScreen ⚠Height - Get window height (in screen coordinates).
- ulWindow
GetScreen ⚠Width - Get window width (in screen coordinates).
- ulWindow
GetWidth ⚠ - Get window width (in pixels).
- ulWindow
Hide ⚠ - Hide the window.
- ulWindow
IsFullscreen ⚠ - Get whether or not a window is fullscreen.
- ulWindow
IsVisible ⚠ - Whether or not the window is currently visible (not hidden).
- ulWindow
Move ⚠To - Move the window to a new position (in screen coordinates) relative to the top-left of the monitor area.
- ulWindow
Move ⚠ToCenter - Move the window to the center of the monitor.
- ulWindow
Pixels ⚠ToScreen - Convert pixels to screen coordinates using the current DPI scale.
- ulWindow
Screen ⚠ToPixels - Convert screen coordinates to pixels using the current DPI scale.
- ulWindow
SetClose ⚠Callback - Set a callback to be notified when a window closes.
- ulWindow
SetCursor ⚠ - Set the cursor for a window.
- ulWindow
SetResize ⚠Callback - Set a callback to be notified when a window resizes (parameters are passed back in pixels).
- ulWindow
SetTitle ⚠ - Set the window title.
- ulWindow
Show ⚠ - Show the window (if it was previously hidden).
Type Aliases§
- JSChar
- @typedef JSChar @abstract A UTF-16 code unit. One, or a sequence of two, can encode any Unicode character. As with all scalar types, endianness depends on the underlying architecture.
- JSClass
Attributes - @typedef JSClassAttributes @abstract A set of JSClassAttributes. Combine multiple attributes by logically ORing them together.
- JSClass
Ref - @typedef JSClassRef A JavaScript class. Used with JSObjectMake to construct objects with custom behavior.
- JSContext
Group Ref - @typedef JSContextGroupRef A group that associates JavaScript contexts with one another. Contexts in the same group may share and exchange JavaScript objects.
- JSContext
Ref - @typedef JSContextRef A JavaScript execution context. Holds the global object and other execution state.
- JSGlobal
Context Ref - @typedef JSGlobalContextRef A global JavaScript execution context. A JSGlobalContext is a JSContext.
- JSObject
Call AsConstructor Callback - @typedef JSObjectCallAsConstructorCallback @abstract The callback invoked when an object is used as a constructor in a ‘new’ expression. @param ctx The execution context to use. @param constructor A JSObject that is the constructor being called. @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of the arguments passed to the function. @param exception A pointer to a JSValueRef in which to return an exception, if any. @result A JSObject that is the constructor’s return value. @discussion If you named your function CallAsConstructor, you would declare it like this:
- JSObject
Call AsConstructor Callback Ex - JSObject
Call AsFunction Callback - @typedef JSObjectCallAsFunctionCallback @abstract The callback invoked when an object is called as a function. @param ctx The execution context to use. @param function A JSObject that is the function being called. @param thisObject A JSObject that is the ‘this’ variable in the function’s scope. @param argumentCount An integer count of the number of arguments in arguments. @param arguments A JSValue array of the arguments passed to the function. @param exception A pointer to a JSValueRef in which to return an exception, if any. @result A JSValue that is the function’s return value. @discussion If you named your function CallAsFunction, you would declare it like this:
- JSObject
Call AsFunction Callback Ex - JSObject
Convert ToType Callback - @typedef JSObjectConvertToTypeCallback @abstract The callback invoked when converting an object to a particular JavaScript type. @param ctx The execution context to use. @param object The JSObject to convert. @param type A JSType specifying the JavaScript type to convert to. @param exception A pointer to a JSValueRef in which to return an exception, if any. @result The objects’s converted value, or NULL if the object was not converted. @discussion If you named your function ConvertToType, you would declare it like this:
- JSObject
Convert ToType Callback Ex - JSObject
Delete Property Callback - @typedef JSObjectDeletePropertyCallback @abstract The callback invoked when deleting a property. @param ctx The execution context to use. @param object The JSObject in which to delete the property. @param propertyName A JSString containing the name of the property to delete. @param exception A pointer to a JSValueRef in which to return an exception, if any. @result true if propertyName was successfully deleted, otherwise false. @discussion If you named your function DeleteProperty, you would declare it like this:
- JSObject
Delete Property Callback Ex - JSObject
Finalize Callback - @typedef JSObjectFinalizeCallback @abstract The callback invoked when an object is finalized (prepared for garbage collection). An object may be finalized on any thread. @param object The JSObject being finalized. @discussion If you named your function Finalize, you would declare it like this:
- JSObject
Finalize Callback Ex - JSObject
GetProperty Callback - @typedef JSObjectGetPropertyCallback @abstract The callback invoked when getting a property’s value. @param ctx The execution context to use. @param object The JSObject to search for the property. @param propertyName A JSString containing the name of the property to get. @param exception A pointer to a JSValueRef in which to return an exception, if any. @result The property’s value if object has the property, otherwise NULL. @discussion If you named your function GetProperty, you would declare it like this:
- JSObject
GetProperty Callback Ex - JSObject
GetProperty Names Callback - @typedef JSObjectGetPropertyNamesCallback @abstract The callback invoked when collecting the names of an object’s properties. @param ctx The execution context to use. @param object The JSObject whose property names are being collected. @param propertyNames A JavaScript property name accumulator in which to accumulate the names of object’s properties. @discussion If you named your function GetPropertyNames, you would declare it like this:
- JSObject
GetProperty Names Callback Ex - JSObject
HasInstance Callback - @typedef JSObjectHasInstanceCallback @abstract hasInstance The callback invoked when an object is used as the target of an ‘instanceof’ expression. @param ctx The execution context to use. @param constructor The JSObject that is the target of the ‘instanceof’ expression. @param possibleInstance The JSValue being tested to determine if it is an instance of constructor. @param exception A pointer to a JSValueRef in which to return an exception, if any. @result true if possibleInstance is an instance of constructor, otherwise false. @discussion If you named your function HasInstance, you would declare it like this:
- JSObject
HasInstance Callback Ex - JSObject
HasProperty Callback - @typedef JSObjectHasPropertyCallback @abstract The callback invoked when determining whether an object has a property. @param ctx The execution context to use. @param object The JSObject to search for the property. @param propertyName A JSString containing the name of the property look up. @result true if object has the property, otherwise false. @discussion If you named your function HasProperty, you would declare it like this:
- JSObject
HasProperty Callback Ex - JSObject
Initialize Callback - @typedef JSObjectInitializeCallback @abstract The callback invoked when an object is first created. @param ctx The execution context to use. @param object The JSObject being created. @discussion If you named your function Initialize, you would declare it like this:
- JSObject
Initialize Callback Ex - JSObject
Ref - @typedef JSObjectRef A JavaScript object. A JSObject is a JSValue.
- JSObject
SetProperty Callback - @typedef JSObjectSetPropertyCallback @abstract The callback invoked when setting a property’s value. @param ctx The execution context to use. @param object The JSObject on which to set the property’s value. @param propertyName A JSString containing the name of the property to set. @param value A JSValue to use as the property’s value. @param exception A pointer to a JSValueRef in which to return an exception, if any. @result true if the property was set, otherwise false. @discussion If you named your function SetProperty, you would declare it like this:
- JSObject
SetProperty Callback Ex - JSProperty
Attributes - @typedef JSPropertyAttributes @abstract A set of JSPropertyAttributes. Combine multiple attributes by logically ORing them together.
- JSProperty
Name Accumulator Ref - @typedef JSPropertyNameAccumulatorRef An ordered set used to collect the names of a JavaScript object’s properties.
- JSProperty
Name Array Ref - @typedef JSPropertyNameArrayRef An array of JavaScript property names.
- JSString
Ref - @typedef JSStringRef A UTF16 character buffer. The fundamental string representation in JavaScript.
- JSType
- @enum JSType @abstract A constant identifying the type of a JSValue. @constant kJSTypeUndefined The unique undefined value. @constant kJSTypeNull The unique null value. @constant kJSTypeBoolean A primitive boolean value, one of true or false. @constant kJSTypeNumber A primitive number value. @constant kJSTypeString A primitive string value. @constant kJSTypeObject An object value (meaning that this JSValueRef is a JSObjectRef). @constant kJSTypeSymbol A primitive symbol value.
- JSTyped
Array Bytes Deallocator - @typedef JSTypedArrayBytesDeallocator A function used to deallocate bytes passed to a Typed Array constructor. The function should take two arguments. The first is a pointer to the bytes that were originally passed to the Typed Array constructor. The second is a pointer to additional information desired at the time the bytes are to be freed.
- JSTyped
Array Type - @enum JSTypedArrayType @abstract A constant identifying the Typed Array type of a JSObjectRef. @constant kJSTypedArrayTypeInt8Array Int8Array @constant kJSTypedArrayTypeInt16Array Int16Array @constant kJSTypedArrayTypeInt32Array Int32Array @constant kJSTypedArrayTypeUint8Array Uint8Array @constant kJSTypedArrayTypeUint8ClampedArray Uint8ClampedArray @constant kJSTypedArrayTypeUint16Array Uint16Array @constant kJSTypedArrayTypeUint32Array Uint32Array @constant kJSTypedArrayTypeFloat32Array Float32Array @constant kJSTypedArrayTypeFloat64Array Float64Array @constant kJSTypedArrayTypeArrayBuffer ArrayBuffer @constant kJSTypedArrayTypeNone Not a Typed Array
- JSValue
Ref - @typedef JSValueRef A JavaScript value. The base type for all JavaScript values, and polymorphic functions on them.
- ULAdd
Console Message Callback - ULApp
- ULBegin
Loading Callback - ULBitmap
- ULBitmap
Format - ULBitmap
Surface - ULBuffer
- ULChange
Cursor Callback - ULChange
Title Callback - ULChange
Tooltip Callback - ULChangeURL
Callback - ULChar16
- ULClipboard
Clear Callback - The callback invoked when the library wants to clear the system’s clipboard.
- ULClipboard
Read Plain Text Callback - The callback invoked when the library wants to read from the system’s clipboard.
- ULClipboard
Write Plain Text Callback - The callback invoked when the library wants to write to the system’s clipboard.
- ULClose
Callback - ULCommand
Type - Command types, used with ULCommand::command_type
- ULConfig
- ULCreate
Child View Callback - ULCursor
- ULDOM
Ready Callback - ULFace
Winding - ULFail
Loading Callback - ULFile
Handle - ULFile
System Close File Callback - The callback invoked when the FileSystem wants to close a previously-opened file.
- ULFile
System File Exists Callback - The callback invoked when the FileSystem wants to check if a file path exists, return true if it exists.
- ULFile
System GetFile Mime Type Callback - The callback invoked when the FileSystem wants to get the mime type of a file (eg “text/html”), store result in ‘result’. Return true on success.
- ULFile
System GetFile Size Callback - The callback invoked when the FileSystem wants to get the file size of a previously opened file, store result in ‘result’. Return true on success.
- ULFile
System Open File Callback - The callback invoked when the FileSystem wants to open a file path for reading or writing. Return file handle on success, or ULInvalidFileHandle on failure.
- ULFile
System Read From File Callback - The callback invoked when the FileSystem wants to read from a currently-opened file, return number of bytes read or -1 on failure.
- ULFinish
Loading Callback - ULFont
Hinting - ULGPU
Driver Begin Synchronize Callback - The callback invoked when the GPUDriver will begin dispatching commands (such as CreateTexture and UpdateCommandList) during the current call to ulRender().
- ULGPU
Driver Create Geometry Callback - The callback invoked when the GPUDriver wants to create geometry with certain ID and vertex/index data.
- ULGPU
Driver Create Render Buffer Callback - The callback invoked when the GPUDriver wants to create a render buffer with certain ID and buffer description.
- ULGPU
Driver Create Texture Callback - The callback invoked when the GPUDriver wants to create a texture with a certain ID and optional bitmap.
- ULGPU
Driver Destroy Geometry Callback - The callback invoked when the GPUDriver wants to destroy geometry.
- ULGPU
Driver Destroy Render Buffer Callback - The callback invoked when the GPUDriver wants to destroy a render buffer
- ULGPU
Driver Destroy Texture Callback - The callback invoked when the GPUDriver wants to destroy a texture.
- ULGPU
Driver EndSynchronize Callback - The callback invoked when the GPUDriver has finished dispatching commands. during the current call to ulRender().
- ULGPU
Driver Next Geometry IdCallback - The callback invoked when the GPUDriver wants to generate the next available geometry ID.
- ULGPU
Driver Next Render Buffer IdCallback - The callback invoked when the GPUDriver wants to generate the next available render buffer ID.
- ULGPU
Driver Next Texture IdCallback - The callback invoked when the GPUDriver wants to get the next available texture ID.
- ULGPU
Driver Update Command List Callback - The callback invoked when the GPUDriver wants to update the command list (you should copy the commands to your own structure).
- ULGPU
Driver Update Geometry Callback - The callback invoked when the GPUDriver wants to update existing geometry with new vertex/index data.
- ULGPU
Driver Update Texture Callback - The callback invoked when the GPUDriver wants to update an existing non-RTT texture with new bitmap data.
- ULIndex
Type - Vertex index type.
- ULKey
Event - ULKey
Event Type - ULLog
Level - Logger
- ULLogger
LogMessage Callback - The callback invoked when the library wants to print a message to the log.
- ULMessage
Level - ULMessage
Source - ULMonitor
- ULMouse
Button - ULMouse
Event - ULMouse
Event Type - ULOverlay
- ULRenderer
- ULResize
Callback - ULScroll
Event - ULScroll
Event Type - ULSession
- ULSettings
- ULShader
Type - Shader types, used with ULGPUState::shader_type
- ULString
- ULSurface
- ULSurface
Definition Create Callback - The callback invoked when a Surface is created.
- ULSurface
Definition Destroy Callback - The callback invoked when a Surface is destroyed.
- ULSurface
Definition GetHeight Callback - The callback invoked when a Surface’s height (in pixels) is requested.
- ULSurface
Definition GetRow Bytes Callback - The callback invoked when a Surface’s row bytes is requested.
- ULSurface
Definition GetSize Callback - The callback invoked when a Surface’s size (in bytes) is requested.
- ULSurface
Definition GetWidth Callback - The callback invoked when a Surface’s width (in pixels) is requested.
- ULSurface
Definition Lock Pixels Callback - The callback invoked when a Surface’s pixel buffer is requested to be locked for reading/writing (should return a pointer to locked bytes).
- ULSurface
Definition Resize Callback - The callback invoked when a Surface is requested to be resized to a certain width/height.
- ULSurface
Definition Unlock Pixels Callback - The callback invoked when a Surface’s pixel buffer is requested to be unlocked after previously being locked.
- ULUpdate
Callback - ULUpdate
History Callback - ULVertex
Buffer Format - Vertex formats.
- ULView
- ULView
Config - ULWindow
- ULWindow
Flags - Window creation flags. @see Window::Create
- ULWindow
Object Ready Callback - __
syscall_ ulong_ t - _bindgen_
ty_ 1 - @enum JSPropertyAttribute @constant kJSPropertyAttributeNone Specifies that a property has no special attributes. @constant kJSPropertyAttributeReadOnly Specifies that a property is read-only. @constant kJSPropertyAttributeDontEnum Specifies that a property should not be enumerated by JSPropertyEnumerators and JavaScript for…in loops. @constant kJSPropertyAttributeDontDelete Specifies that the delete operation should fail on a property.
- _bindgen_
ty_ 2 - @enum JSClassAttribute @constant kJSClassAttributeNone Specifies that a class has no special attributes. @constant kJSClassAttributeNoAutomaticPrototype Specifies that a class should not automatically generate a shared prototype for its instance objects. Use kJSClassAttributeNoAutomaticPrototype in combination with JSObjectSetPrototype to manage prototypes manually.
- size_t