BeginScrollView
Begin a scrolling view inside your GUI.
Read time 6 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.IMGUIModule
BeginScrollView(Rect, Vector2, Rect)
Begin a scrolling view inside your GUI.
public static Vector2 BeginScrollView(Rect position, Vector2 scrollPosition, Rect viewRect)
Parameters
Returns
Type | Description |
|---|---|
| Vector2 | The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. |
Remarks
ScrollViews let you make a smaller area on-screen look 'into' a much larger area, using scrollbars placed on the sides of the ScrollView.
Examples
using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ // The position on of the scrolling viewport public Vector2 scrollPosition = Vector2.zero; void OnGUI() { // An absolute-positioned example: We make a scrollview that has a really large client // rect and put it in a small rect on the screen. scrollPosition = GUI.BeginScrollView(new Rect(10, 300, 100, 100), scrollPosition, new Rect(0, 0, 220, 200)); // Make four buttons - one in each corner. The coordinate system is defined // by the last parameter to BeginScrollView. GUI.Button(new Rect(0, 0, 100, 20), "Top-left"); GUI.Button(new Rect(120, 0, 100, 20), "Top-right"); GUI.Button(new Rect(0, 180, 100, 20), "Bottom-left"); GUI.Button(new Rect(120, 180, 100, 20), "Bottom-right"); // End the scroll view that we began above. GUI.EndScrollView(); }}
BeginScrollView(Rect, Vector2, Rect, bool, bool)
Begin a scrolling view inside your GUI.
public static Vector2 BeginScrollView(Rect position, Vector2 scrollPosition, Rect viewRect, bool alwaysShowHorizontal, bool alwaysShowVertical)
Parameters
Rectangle on the screen to use for the ScrollView.
The pixel distance that the view is scrolled in the X and Y directions.
The rectangle used inside the scrollview.
Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when is wider than .
viewRectpositionOptional parameter to always show the vertical scrollbar. If false or left out, it is only shown when is taller than .
viewRectpositionReturns
Type | Description |
|---|---|
| Vector2 | The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. |
Remarks
ScrollViews let you make a smaller area on-screen look 'into' a much larger area, using scrollbars placed on the sides of the ScrollView.
Examples
using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ // The position on of the scrolling viewport public Vector2 scrollPosition = Vector2.zero; void OnGUI() { // An absolute-positioned example: We make a scrollview that has a really large client // rect and put it in a small rect on the screen. scrollPosition = GUI.BeginScrollView(new Rect(10, 300, 100, 100), scrollPosition, new Rect(0, 0, 220, 200)); // Make four buttons - one in each corner. The coordinate system is defined // by the last parameter to BeginScrollView. GUI.Button(new Rect(0, 0, 100, 20), "Top-left"); GUI.Button(new Rect(120, 0, 100, 20), "Top-right"); GUI.Button(new Rect(0, 180, 100, 20), "Bottom-left"); GUI.Button(new Rect(120, 180, 100, 20), "Bottom-right"); // End the scroll view that we began above. GUI.EndScrollView(); }}
BeginScrollView(Rect, Vector2, Rect, GUIStyle, GUIStyle)
Begin a scrolling view inside your GUI.
public static Vector2 BeginScrollView(Rect position, Vector2 scrollPosition, Rect viewRect, GUIStyle horizontalScrollbar, GUIStyle verticalScrollbar)
Parameters
Rectangle on the screen to use for the ScrollView.
The pixel distance that the view is scrolled in the X and Y directions.
The rectangle used inside the scrollview.
Returns
Type | Description |
|---|---|
| Vector2 | The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. |
Remarks
ScrollViews let you make a smaller area on-screen look 'into' a much larger area, using scrollbars placed on the sides of the ScrollView.
Examples
using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ // The position on of the scrolling viewport public Vector2 scrollPosition = Vector2.zero; void OnGUI() { // An absolute-positioned example: We make a scrollview that has a really large client // rect and put it in a small rect on the screen. scrollPosition = GUI.BeginScrollView(new Rect(10, 300, 100, 100), scrollPosition, new Rect(0, 0, 220, 200)); // Make four buttons - one in each corner. The coordinate system is defined // by the last parameter to BeginScrollView. GUI.Button(new Rect(0, 0, 100, 20), "Top-left"); GUI.Button(new Rect(120, 0, 100, 20), "Top-right"); GUI.Button(new Rect(0, 180, 100, 20), "Bottom-left"); GUI.Button(new Rect(120, 180, 100, 20), "Bottom-right"); // End the scroll view that we began above. GUI.EndScrollView(); }}
BeginScrollView(Rect, Vector2, Rect, bool, bool, GUIStyle, GUIStyle)
Begin a scrolling view inside your GUI.
public static Vector2 BeginScrollView(Rect position, Vector2 scrollPosition, Rect viewRect, bool alwaysShowHorizontal, bool alwaysShowVertical, GUIStyle horizontalScrollbar, GUIStyle verticalScrollbar)
Parameters
Rectangle on the screen to use for the ScrollView.
The pixel distance that the view is scrolled in the X and Y directions.
The rectangle used inside the scrollview.
Optional parameter to always show the horizontal scrollbar. If false or left out, it is only shown when is wider than .
viewRectpositionOptional parameter to always show the vertical scrollbar. If false or left out, it is only shown when is taller than .
viewRectpositionReturns
Type | Description |
|---|---|
| Vector2 | The modified scrollPosition. Feed this back into the variable you pass in, as shown in the example. |
Remarks
ScrollViews let you make a smaller area on-screen look 'into' a much larger area, using scrollbars placed on the sides of the ScrollView.
Examples
using UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{ // The position on of the scrolling viewport public Vector2 scrollPosition = Vector2.zero; void OnGUI() { // An absolute-positioned example: We make a scrollview that has a really large client // rect and put it in a small rect on the screen. scrollPosition = GUI.BeginScrollView(new Rect(10, 300, 100, 100), scrollPosition, new Rect(0, 0, 220, 200)); // Make four buttons - one in each corner. The coordinate system is defined // by the last parameter to BeginScrollView. GUI.Button(new Rect(0, 0, 100, 20), "Top-left"); GUI.Button(new Rect(120, 0, 100, 20), "Top-right"); GUI.Button(new Rect(0, 180, 100, 20), "Bottom-left"); GUI.Button(new Rect(120, 180, 100, 20), "Bottom-right"); // End the scroll view that we began above. GUI.EndScrollView(); }}