Streampixel Documentation
  • Resources
    • Quick Start Guide
      • Register & Sign In
      • Prepare your Unreal Engine project for Windows
      • Configuring Your Project
      • Uploading Your Build
      • Sharing & Embedding
      • Resolution Settings
      • Codec Settings
      • Mouse Settings
      • Security Control
      • Analytics Feature
      • Additional Settings
    • Custom Integration Guide
      • Setting up your Frontend
        • Basic Iframe Integeration
        • Frontend and Application Communication
        • Stream States
        • Stream Control Commands
      • Sample Code for HTML and React
      • Blueprint Setup for Sending and Receiving JSON Messages from the Frontend in Unreal Engine
    • Additional Unreal Engine Features
      • Playing Media Files
  • Frequently Asked Questions
Powered by GitBook
On this page
  • Overview
  • Configuring Mouse Behavior in Pixel Streaming
  • For Web-Based UI
  • For In-Game UI
  • Making Mouse Appear Only in Menus (Optional)
  1. Resources
  2. Quick Start Guide

Mouse Settings

Guide to configuring mouse settings for Pixel Streaming in Unreal Engine, covering web-based and in-game UI interactions.

PreviousCodec SettingsNextSecurity Control

Last updated 3 months ago

Overview

There may be times when you want to fully disable the mouse within Unreal Engine and rely solely on the frontend mouse controls or completely remove mouse interactions.

Configuring Mouse Behavior in Pixel Streaming

The approach to mouse interaction depends on whether your UI is handled within a web browser or directly inside Unreal Engine.

For Web-Based UI

Hiding Unreal Engine’s Mouse Cursor

  • Open Project Settings > Plugins > Pixel Streaming.

  • Set Default Cursor Class Name to HiddenCursor.

  • This prevents Unreal Engine from displaying an extra cursor when using a web UI.

Adjusting Mouse Capture and Lock Settings

  • Navigate to Edit > Project Settings > Engine > Input.

  • Set Default Viewport Mouse Capture Mode to Capture Permanently Including Initial Mouse Down to ensure all clicks are registered.

  • Set Default Viewport Mouse Lock Mode to Do Not Lock, allowing users to interact with web elements without manually unlocking the cursor.

  • Some external settings may override this, but it’s useful for local testing.

Disabling Hovering Mouse on Streampixel

  • Navigate to Project Settings > Hovering Mouse in your streaming platform.

  • Set Hovering Mouse to Disabled to keep the browser’s default cursor active for seamless interaction with the web UI.

For In-Game UI

Enabling Unreal Engine’s Mouse Cursor

  • Open Project Settings > Plugins > Pixel Streaming.

  • Set Default Cursor Class Name to DefaultCursor.

  • If the streaming platform’s Mouse Lock feature is enabled, Unreal Engine’s cursor must be visible for in-game interactions.

Configuring Mouse Lock Settings in Unreal Engine

  • Open Edit > Project Settings > Engine > Input.

  • Set Default Viewport Mouse Capture Mode to Capture Permanently Including Initial Mouse Down.

  • Choose a Mouse Lock Mode based on your needs:

    • Lock On Capture

    • Lock Always

    • Lock in Fullscreen

  • These settings keep the mouse inside the game window, ideal for first-person or interactive experiences.

Enabling Mouse Lock in the Streaming Platform

  • Navigate to Settings > General > Mouse Lock.

  • Set Mouse Lock to Enabled to keep the cursor inside the stream window until the user presses ‘Escape’ to unlock it.

Making Mouse Appear Only in Menus (Optional)

  • If your project has an in-game menu, the mouse should appear only when the menu is open.

  • Toggle cursor visibility dynamically using Blueprint nodes:

    • HiddenCursor (to hide the cursor)

    • DefaultCursor (to show the cursor)

  • Adjust input modes dynamically:

    • Set Input Mode Game Only (for gameplay without UI interaction)

    • Set Input Mode Game and UI (for interactive menus and UI elements)

  • Customize these settings based on your project’s needs.