wscweb.h File Reference

WSCLibWeb — Headless Chromium browser rendering API via CEF. More...

#include <windows.h>

Go to the source code of this file.

Data Structures
struct	WSCWVersion
	Version information structure. More...

Macros
#define	WSCW_API   extern "C" __declspec(dllexport)
#define	WSCW_VERSION_MAJOR   1
#define	WSCW_VERSION_MINOR   0
#define	WSCW_VERSION_PATCH   0
#define	WSCW_VERSION_STRING   "1.0.0"

Enumerations
enum	WSCWResult {   WSCW_OK = 0 , WSCW_ERROR_NOT_INIT = -200 , WSCW_ERROR_INVALID_PARAM = -201 , WSCW_ERROR_CEF_FAIL = -202 ,   WSCW_ERROR_INVALID_ID = -203 , WSCW_ERROR_ALREADY_INIT = -204 , WSCW_ERROR_ALLOC_FAIL = -205 }
	Result codes returned by WSCLibWeb functions. More...
enum	WSCWMouseButton { WSCW_MOUSE_LEFT = 0 , WSCW_MOUSE_MIDDLE = 1 , WSCW_MOUSE_RIGHT = 2 }
	Mouse button identifiers. More...

Functions
WSCWVersion	WSCW_GetVersion ()
	Get WSCLibWeb version info.
WSCWResult	WSCW_Init ()
	Initialize CEF engine.
void	WSCW_Shutdown ()
	Shut down CEF engine and destroy all browsers.
void	WSCW_DoMessageLoopWork ()
	Pump CEF message loop.
int	WSCW_CreateBrowser (const char *url, int width, int height)
	Create an off-screen browser and navigate to a URL.
WSCWResult	WSCW_DestroyBrowser (int browserId)
	Destroy a browser and free resources.
WSCWResult	WSCW_Navigate (int browserId, const char *url)
	Navigate to a new URL.
WSCWResult	WSCW_Reload (int browserId)
	Reload the current page.
WSCWResult	WSCW_GoBack (int browserId)
	Navigate back.
WSCWResult	WSCW_GoForward (int browserId)
	Navigate forward.
WSCWResult	WSCW_Resize (int browserId, int width, int height)
	Resize the virtual viewport.
WSCWResult	WSCW_ExecuteJS (int browserId, const char *code)
	Execute JavaScript code in the browser's main frame.
WSCWResult	WSCW_SetFrameRate (int browserId, int fps)
	Set the frame rate for off-screen rendering.
WSCWResult	WSCW_SendMouseMove (int browserId, int x, int y)
	Send a mouse move event.
WSCWResult	WSCW_SendMouseDown (int browserId, WSCWMouseButton button, int x, int y)
	Send a mouse button down event.
WSCWResult	WSCW_SendMouseUp (int browserId, WSCWMouseButton button, int x, int y)
	Send a mouse button up event.
WSCWResult	WSCW_SendMouseWheel (int browserId, int x, int y, int deltaX, int deltaY)
	Send a mouse scroll event.
WSCWResult	WSCW_SendKeyEvent (int browserId, int keyCode, int isKeyUp, int modifiers)
	Send a key event.
WSCWResult	WSCW_SendChar (int browserId, int character)
	Send a character input event (for text input).
WSCWResult	WSCW_AttachOutput (int browserId, int outputId)
	Attach a WSCLib output to this browser.
WSCWResult	WSCW_DetachOutput (int browserId, int outputId)
	Detach a WSCLib output from this browser.

Detailed Description

WSCLibWeb — Headless Chromium browser rendering API via CEF.

Provides off-screen Chromium browser instances that deliver rendered web pages as BGRA frames to WSCLib outputs. Supports navigation, JavaScript execution, mouse/keyboard input, and resize.

Version

1.0.0

Macro Definition Documentation

WSCW_API

#define WSCW_API   extern "C" __declspec(dllexport)