Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.streampixel.io/llms.txt

Use this file to discover all available pages before exploring further.

How you configure the mouse depends on where your UI lives — in the browser overlay or inside Unreal itself.

​
For web-based UI

Hide Unreal’s cursor and let the browser handle it.

​
Hide Unreal’s cursor

1

Open Pixel Streaming plugin settings

Project Settings → Plugins → Pixel Streaming.
2

Set Default Cursor Class Name to HiddenCursor

Stops UE from drawing a second cursor.

​
Mouse capture and lock

1

Open Edit → Project Settings → Engine → Input

Engine Input settings.
2

Set Default Viewport Mouse Capture Mode

Capture Permanently Including Initial Mouse Down.
3

Set Default Viewport Mouse Lock Mode

Do Not Lock.

​
Disable Hovering Mouse in Streampixel

In the dashboard, set Project Settings → Hovering Mouse → Disabled so the browser’s native cursor stays active.

​
For in-game (Unreal) UI

Show Unreal’s cursor and lock it inside the viewport.

​
Show Unreal’s cursor

In the Pixel Streaming plugin, set Default Cursor Class Name to DefaultCursor.

​
Lock the cursor

1

Edit → Project Settings → Engine → Input

2

Default Viewport Mouse Capture Mode

Capture Permanently Including Initial Mouse Down.
3

Default Viewport Mouse Lock Mode

Pick one: Lock On Capture, Lock Always, or Lock in Fullscreen.
In the dashboard: Settings → General → Mouse Lock → Enabled. The cursor stays inside the stream until the viewer presses Escape.

​
Toggle cursor visibility at runtime

Switch between hidden and visible based on game state — e.g. hide during gameplay, show in menus.

​
From Unreal

Send a JSON message via Send Pixel Streaming Response: 
// Show cursor
{"message": {"type": "togglehoveringmouse", "value": true}}

// Hide cursor
{"message": {"type": "togglehoveringmouse", "value": false}}

​
From an iframe

Use postMessage with the same JSON. See stream control commands.

​
In-game menu cursors

Toggle cursor visibility from Blueprints:
  • HiddenCursor to hide
  • DefaultCursor to show
Pair with input mode changes:
  • Set Input Mode Game Only — gameplay
  • Set Input Mode Game and UI — menus