You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation.html
+9Lines changed: 9 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -142,6 +142,7 @@ <h3>Configuration</h3>
142
142
<ul>
143
143
<li><strong>Project ID</strong>: Your BetaHub project identifier (found in Project Settings > General > Project Information).</li>
144
144
<li><strong>Auth Token</strong>: Your application token for API authentication (found in Project Settings > Integrations > Tokens). This is <strong>not an API key</strong> and does not need to be kept secret - it's a project identifier that helps prevent API abuse and spam while identifying your application.</li>
145
+
<li><strong>Default Email Address</strong>: <em>Optional programmatic field.</em> If set, this email address will be used as the default email address of the reporter. This is a hidden field intended to be pre-filled programmatically by the developer if the user is already logged in with a specific email address.</li>
145
146
<li><strong>Shortcut Key</strong>: Default is F12. Set to None to disable and open the form programmatically.</li>
146
147
<li><strong>Performance_Sampler</strong>
147
148
<ul>
@@ -154,10 +155,18 @@ <h3>Configuration</h3>
154
155
<li><strong>Frame Rate</strong>: Default is 30. Higher rates may increase file size and resource usage.</li>
155
156
<li><strong>Recording Duration</strong>: Default is 60 seconds.</li>
156
157
<li><strong>Downscale Video</strong>: <em>Off by default.</em> If enabled, the video will be downscaled to a maximum resolution (default: 1920x1080) if your game runs at a higher resolution. This helps reduce CPU usage and file size when recording on high-resolution displays. Enable this option in the inspector if you notice high CPU usage or stuttering during recording at large resolutions.</li>
158
+
<li><strong>Render FPS Overlay</strong>: <em>On by default.</em> When enabled, the current FPS (frames per second) will be displayed as an overlay on the recorded video. This is useful for performance analysis and helps identify frame rate issues during bug reports. The FPS counter appears in the bottom-left corner of the video.</li>
157
159
<li><strong>Render Cursor</strong>: <em>Off by default.</em> When enabled, the mouse cursor position will be rendered in the recorded video. This is useful for showing user interactions and click locations during bug reports. The cursor is drawn as a white arrow with a black outline for visibility against different backgrounds.</li>
160
+
<li><strong>Mirror Vertically</strong>: <em>Off by default.</em> When enabled, the recorded video will be flipped vertically (upside down). This setting is useful for specific rendering setups or platforms where the video output needs to be inverted.</li>
158
161
<li><strong>Capture Render Texture</strong>: <em>Optional.</em> When set, the recorder will capture from this specific render texture instead of the main screen. This is useful for recording from specific cameras, UI canvases, or other render targets. The recorder will automatically handle scaling if the render texture dimensions don't match the output resolution. Leave empty to record the main screen.</li>
159
162
</ul>
160
163
</li>
164
+
<li><strong>Unity Events</strong>
165
+
<ul>
166
+
<li><strong>On Bug Report Window Shown</strong>: Unity event triggered when the bug reporting window is displayed. Use this to pause your game, modify UI states, or perform other actions when bug reporting begins.</li>
167
+
<li><strong>On Bug Report Window Hidden</strong>: Unity event triggered when the bug reporting window is closed or hidden. Use this to resume your game, restore UI states, or perform cleanup actions when bug reporting ends.</li>
0 commit comments