UnityEngine.CoreModule

Structure describing acceleration status of the device.

Value of acceleration.

Amount of time passed since last accelerometer measurement.

The AddComponentMenu attribute allows you to place a script anywhere in the "Component" menu, instead of just the "Component->Scripts" menu.

The order of the component in the component menu (lower is higher to the top).

Add an item in the Component menu.

The path to the component. Where in the component menu to add the new item.

Add an item in the Component menu.

The path to the component. Where in the component menu to add the new item.

AndroidJavaClass is the Unity representation of a generic instance of java.lang.Class.

Construct an AndroidJavaClass from the class name.

Specifies the Java class name (e.g. <tt>java.lang.String</tt>).

AndroidJavaObject is the Unity representation of a generic instance of java.lang.Object.

Calls a Java method on an object (non-static).

Specifies which method to call. An array of parameters passed to the method.

Call a Java method on an object.

Specifies which method to call. An array of parameters passed to the method.

Call a static Java method on a class.

Specifies which method to call. An array of parameters passed to the method.

Call a static Java method on a class.

Specifies which method to call. An array of parameters passed to the method.

Construct an AndroidJavaObject based on the name of the class.

Specifies the Java class name (e.g. "<tt>java.lang.String<tt>" or "<tt>javalangString<tt>"). An array of parameters passed to the constructor.

IDisposable callback.

Get the value of a field in an object (non-static).

The name of the field (e.g. int counter; would have fieldName = "counter").

Retrieves the raw <tt>jclass</tt> pointer to the Java class. Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Retrieves the raw <tt>jobject</tt> pointer to the Java object. Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Get the value of a static field in an object type.

The name of the field (e.g. <i>int counter;</i> would have fieldName = "counter").

Set the value of a field in an object (non-static).

The name of the field (e.g. int counter; would have fieldName = "counter"). The value to assign to the field. It has to match the field type.

Set the value of a static field in an object type.

The name of the field (e.g. int counter; would have fieldName = "counter"). The value to assign to the field. It has to match the field type.

This class can be used to implement any java interface. Any java vm method invocation matching the interface on the proxy object will automatically be passed to the c# implementation.

The equivalent of the java.lang.Object equals() method.

Returns true when the objects are equal and false if otherwise.

The equivalent of the java.lang.Object hashCode() method.

Returns the hash code of the java proxy object.

Java interface implemented by the proxy.

The equivalent of the java.lang.Object toString() method.

Returns C# class name + " <c# proxy java object>".

Java interface to be implemented by the proxy.

Called by the java vm whenever a method is invoked on the java proxy interface. You can override this to run special code on method invokation, or you can leave the implementation as is, and leave the default behavior which is to look for c# methods matching the signature of the java method.

Name of the invoked java method. Arguments passed from the java vm - converted into AndroidJavaObject, AndroidJavaClass or a primitive. Arguments passed from the java vm - all objects are represented by AndroidJavaObject, int for instance is represented by a java.lang.Integer object.

AndroidJavaRunnable is the Unity representation of a java.lang.Runnable object.

'Raw' JNI interface to Android Dalvik (Java) VM from Mono (CS/JS). Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Allocates a new Java object without invoking any of the constructors for the object.

Attaches the current thread to a Java (Dalvik) VM.

Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method.

Invokes a static method on a Java object, according to the specified <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method.

Calls an instance (nonstatic) Java method defined by <tt>methodID<tt>, optionally passing an array of arguments (<tt>args<tt>) to the method.

Deletes the global reference pointed to by <tt>obj</tt>.

Deletes the local reference pointed to by <tt>obj</tt>.

Detaches the current thread from a Java (Dalvik) VM.

Ensures that at least a given number of local references can be created in the current thread.

Clears any exception that is currently being thrown.

Prints an exception and a backtrace of the stack to the <tt>logcat</tt>

Determines if an exception is being thrown.

Raises a fatal error and does not expect the VM to recover. This function does not return.

This function loads a locally-defined class.

Convert a Java array of <tt>boolean</tt> to a managed array of System.Boolean.

Convert a Java array of <tt>byte</tt> to a managed array of System.Byte.

Convert a Java array of <tt>char</tt> to a managed array of System.Char.

Convert a Java array of <tt>double</tt> to a managed array of System.Double.

Convert a Java array of <tt>float</tt> to a managed array of System.Single.

Convert a Java array of <tt>int</tt> to a managed array of System.Int32.

Convert a Java array of <tt>long</tt> to a managed array of System.Int64.

Convert a Java array of <tt>java.lang.Object</tt> to a managed array of System.IntPtr, representing Java objects.

Converts a <tt>java.lang.reflect.Field</tt> to a field ID.

Converts a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object to a method ID.

Convert a Java array of <tt>short</tt> to a managed array of System.Int16.

Returns the number of elements in the array.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the field ID for an instance (nonstatic) field of a class.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

Returns the method ID for an instance (nonstatic) method of a class or interface.

Returns an element of an <tt>Object</tt> array.

Returns the class of an object.

This function returns the value of an instance (nonstatic) field of an object.

Returns the value of one element of a primitive array.

This function returns the value of an instance (nonstatic) field of an object.

This function returns the value of a static field of an object.

Returns the field ID for a static field of a class.

This function returns the value of a static field of an object.

Returns the method ID for a static method of a class.

This function returns the value of a static field of an object.

This function returns the value of an instance (nonstatic) field of an object.

Returns a managed string object representing the string in modified UTF-8 encoding.

Returns the length in bytes of the modified UTF-8 representation of a string.

If <tt>clazz<tt> represents any class other than the class <tt>Object<tt>, then this function returns the object that represents the superclass of the class specified by <tt>clazz</tt>.

Returns the version of the native method interface.

Determines whether an object of <tt>clazz1<tt> can be safely cast to <tt>clazz2<tt>.

Tests whether an object is an instance of a class.

Tests whether two references refer to the same Java object.

Construct a new primitive array object.

Creates a new global reference to the object referred to by the <tt>obj</tt> argument.

Construct a new primitive array object.

Creates a new local reference that refers to the same object as <tt>obj</tt>.

Construct a new primitive array object.

Constructs a new Java object. The method ID indicates which constructor method to invoke. This ID must be obtained by calling GetMethodID() with <init> as the method name and void (V) as the return type.

Constructs a new array holding objects in class <tt>clazz<tt>. All elements are initially set to <tt>obj<tt>.

Construct a new primitive array object.

Constructs a new <tt>java.lang.String</tt> object from an array of characters in modified UTF-8 encoding.

Pops off the current local reference frame, frees all the local references, and returns a local reference in the previous local reference frame for the given <tt>result</tt> object.

Creates a new local reference frame, in which at least a given number of local references can be created.

Sets the value of one element in a primitive array.

The array of native booleans. Index of the array element to set. The value to set - for 'true' use 1, for 'false' use 0.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

Sets an element of an <tt>Object</tt> array.

This function sets the value of an instance (nonstatic) field of an object.

Sets the value of one element in a primitive array.

This function sets the value of an instance (nonstatic) field of an object.

This function ets the value of a static field of an object.

This function sets the value of an instance (nonstatic) field of an object.

Causes a <tt>java.lang.Throwable</tt> object to be thrown.

Constructs an exception object from the specified class with the <tt>message</tt> specified by message and causes that exception to be thrown.

Convert a managed array of System.Boolean to a Java array of <tt>boolean</tt>.

Convert a managed array of System.Byte to a Java array of <tt>byte</tt>.

Convert a managed array of System.Char to a Java array of <tt>char</tt>.

Convert a managed array of System.Double to a Java array of <tt>double</tt>.

Convert a managed array of System.Single to a Java array of <tt>float</tt>.

Convert a managed array of System.Int32 to a Java array of <tt>int</tt>.

Convert a managed array of System.Int64 to a Java array of <tt>long</tt>.

Convert a managed array of System.IntPtr, representing Java objects, to a Java array of <tt>java.lang.Object</tt>.

Converts a field ID derived from cls to a <tt>java.lang.reflect.Field</tt> object.

Converts a method ID derived from clazz to a <tt>java.lang.reflect.Method<tt> or <tt>java.lang.reflect.Constructor<tt> object.

Convert a managed array of System.Int16 to a Java array of <tt>short</tt>.

Helper interface for JNI interaction; signature creation and method lookups. Note: Using raw JNI functions requires advanced knowledge of the Android Java Native Interface (JNI). Please take note.

Set debug to true to log calls through the AndroidJNIHelper.

Creates a managed array from a Java array.

Java array object to be converted into a managed array.

Creates a Java array from a managed array.

Managed array to be converted into a Java array object.

Creates a java proxy object which connects to the supplied proxy implementation.

An implementatinon of a java interface in c#.

Creates a UnityJavaRunnable object (implements java.lang.Runnable).

A delegate representing the java.lang.Runnable.

Creates the parameter array to be used as argument list when invoking Java code through CallMethod() in AndroidJNI.

An array of objects that should be converted to Call parameters.

Deletes any local jni references previously allocated by CreateJNIArgArray().

The array of arguments used as a parameter to CreateJNIArgArray(). The array returned by CreateJNIArgArray().

Scans a particular Java class for a constructor method matching a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Constructor method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature).

Scans a particular Java class for a constructor method matching a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Constructor method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature).

Get a JNI method ID for a constructor based on calling arguments.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Array with parameters to be passed to the constructor when invoked.

Scans a particular Java class for a field matching a name and a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the field as declared in Java. Field signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields.

Scans a particular Java class for a field matching a name and a signature.

Get a JNI field ID based on type detection. Generic parameter represents the field type.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the field as declared in Java. Set to <tt>true<tt> for static fields; <tt>false<tt> for instance (nonstatic) fields.

Scans a particular Java class for a method matching a name and a signature.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the method as declared in Java. Method signature (e.g. obtained by calling AndroidJNIHelper.GetSignature). Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods.

Scans a particular Java class for a method matching a name and a signature.

Get a JNI method ID based on calling arguments.

Raw JNI Java class object (obtained by calling AndroidJNI.FindClass). Name of the method as declared in Java. Array with parameters to be passed to the method when invoked. Set to <tt>true<tt> for static methods; <tt>false<tt> for instance (nonstatic) methods.

Get a JNI method ID based on calling arguments.

Creates the JNI signature string for particular object type.

Object for which a signature is to be produced.

Creates the JNI signature string for an object parameter list.

Array of object for which a signature is to be produced.

Creates the JNI signature string for an object parameter list.

Array of object for which a signature is to be produced.

Store a collection of Keyframes that can be evaluated over time.

All keys defined in the animation curve.

The number of keys in the curve. (Read Only)

The behaviour of the animation after the last keyframe.

The behaviour of the animation before the first keyframe.

Add a new key to the curve.

The time at which to add the key (horizontal axis in the curve graph). The value for the key (vertical axis in the curve graph). The index of the added key, or -1 if the key could not be added.

Add a new key to the curve.

The key to add to the curve. The index of the added key, or -1 if the key could not be added.

Creates a constant "curve" starting at timeStart, ending at timeEnd and with the value value.

The start time for the constant curve. The start time for the constant curve. The value for the constant curve. The constant curve created from the specified values.

Creates an animation curve from an arbitrary number of keyframes.

An array of Keyframes used to define the curve.

Creates an empty animation curve.

Creates an ease-in and out curve starting at timeStart, valueStart and ending at timeEnd, valueEnd.

The start time for the ease curve. The start value for the ease curve. The end time for the ease curve. The end value for the ease curve. The ease-in and out curve generated from the specified values.

Evaluate the curve at time.

The time within the curve you want to evaluate (the horizontal axis in the curve graph). The value of the curve, at the point in time specified.

A straight Line starting at timeStart, valueStart and ending at timeEnd, valueEnd.

The start time for the linear curve. The start value for the linear curve. The end time for the linear curve. The end value for the linear curve. The linear curve created from the specified values.

Removes the keyframe at index and inserts key.

The index of the key to move. The key (with its new time) to insert. The index of the keyframe after moving it.

Removes a key.

The index of the key to remove.

Smooth the in and out tangents of the keyframe at index.

The index of the keyframe to be smoothed. The smoothing weight to apply to the keyframe's tangents.

Retrieves the key at index. (Read Only)

Anisotropic filtering mode.

Disable anisotropic filtering for all textures.

Enable anisotropic filtering, as set for each texture.

Enable anisotropic filtering for all textures.

Access to application run-time data.

The URL of the document (what is shown in a browser's address bar) for WebGL (Read Only).

Priority of background loading thread.

Returns a GUID for this build (Read Only).

A unique cloud project identifier. It is unique for every project (Read Only).

Return application company name (Read Only).

Contains the path to the game data folder (Read Only).

Returns false if application is altered in any way after it was built.

Returns true if application integrity can be confirmed.

Returns application identifier at runtime. On Apple platforms this is the 'bundleIdentifier' saved in the info.plist file, on Android it's the 'package' from the AndroidManifest.xml.

Returns the name of the store or package that installed the application (Read Only).

Returns application install mode (Read Only).

Returns the type of Internet reachability currently possible on the device.

Is the current Runtime platform a known console platform.

Are we running inside the Unity editor? (Read Only)

Whether the player currently has focus. Read-only.

Is some level being loaded? (Read Only) (Obsolete).

Is the current Runtime platform a known mobile platform.

Returns true when in any kind of player is active.(Read Only).

Checks whether splash screen is being shown.

Are we running inside a web player? (Read Only)

The total number of levels available (Read Only).

The level index that was last loaded (Read Only).

The name of the level that was last loaded (Read Only).

Event that is fired if a log message is received.

This event occurs when an iOS or Android device notifies of low memory while the app is running in the foreground. You can release non-critical assets from memory (such as, textures or audio clips) in response to this in order to avoid the app being terminated. You can also load smaller versions of such assets. Furthermore, you should serialize any transient data to permanent storage to avoid data loss if the app is terminated. This event corresponds to the following callbacks on the different platforms: - iOS: [UIApplicationDelegate applicationDidReceiveMemoryWarning] - Android: onLowMemory() and onTrimMemory(level == TRIM_MEMORY_RUNNING_CRITICAL) Here is an example of handling the callback:

Delegate method used to register for "Just Before Render" input updates for VR devices.

Contains the path to a persistent data directory (Read Only).

Returns the platform the game is running on (Read Only).

Returns application product name (Read Only).

Unity raises this event when the player application is qutting.

Should the player be running when the application is in the background?

Returns application running in sandbox (Read Only).

The path to the web player data file relative to the html file (Read Only).

Stack trace logging options. The default value is StackTraceLogType.ScriptOnly.

How many bytes have we downloaded from the main unity web stream (Read Only).

Contains the path to the StreamingAssets folder (Read Only).

The language the user's operating system is running in.

Instructs game to try to render at a specified frame rate.

Contains the path to a temporary data / cache directory (Read Only).

The version of the Unity runtime used to play the content.

Returns application version number (Read Only).

Unity raises this event when the player application wants to quit.

Indicates whether Unity's webplayer security model is enabled.

Delegate method for fetching advertising ID.

Advertising ID. Indicates whether user has chosen to limit ad tracking. Error message.

Cancels quitting the application. This is useful for showing a splash screen at the end of a game.

Can the streamed level be loaded?

Captures a screenshot at path filename as a PNG file.

Pathname to save the screenshot file to. Factor by which to increase resolution.

Captures a screenshot at path filename as a PNG file.

Pathname to save the screenshot file to. Factor by which to increase resolution.

Calls a function in the web page that contains the WebGL Player.

Name of the function to call. Array of arguments passed in the call.

Execution of a script function in the contained web page.

The Javascript function to call.

Returns an array of feature tags in use for this build.

Get stack trace logging options. The default value is StackTraceLogType.ScriptOnly.

How far has the download progressed? [0...1].

Is Unity activated with the Pro license?

Check if the user has authorized use of the webcam or microphone in the Web Player.

Note: This is now obsolete. Use SceneManager.LoadScene instead.

The level to load. The name of the level to load.

Note: This is now obsolete. Use SceneManager.LoadScene instead.

The level to load. The name of the level to load.

Loads a level additively.

Loads the level additively and asynchronously in the background.

Loads the level asynchronously in the background.

Use this delegate type with Application.logMessageReceived or Application.logMessageReceivedThreaded to monitor what gets logged.

This is the delegate function when a mobile device notifies of low memory.

Opens the url in a browser.

Quits the player application.

Request advertising ID for iOS, Android and Windows Store.

Delegate method. Returns true if successful, or false for platforms which do not support Advertising Identifiers. In this case, the delegate method is not invoked.

Request authorization to use the webcam or microphone in the Web Player.

Set an array of feature tags for this build.

Set stack trace logging options. The default value is StackTraceLogType.ScriptOnly.

Unloads the Unity runtime.

Unloads all GameObject associated with the given scene. Note that assets are currently not unloaded, in order to free up asset memory call Resources.UnloadAllUnusedAssets.

Index of the scene in the PlayerSettings to unload. Name of the scene to Unload. Return true if the scene is unloaded.

Unloads all GameObject associated with the given scene. Note that assets are currently not unloaded, in order to free up asset memory call Resources.UnloadAllUnusedAssets.

Index of the scene in the PlayerSettings to unload. Name of the scene to Unload. Return true if the scene is unloaded.

Application installation mode (Read Only).

Application installed via ad hoc distribution.

Application installed via developer build.

Application running in editor.

Application installed via enterprise distribution.

Application installed via online store.

Application install mode unknown.

Application sandbox type.

Application not running in a sandbox.

Application is running in broken sandbox.

Application is running in a sandbox.

Application sandbox type is unknown.

Assembly level attribute. Any classes in an assembly with this attribute will be considered to be Editor Classes.

Constructor.

The Assert class contains assertion methods for setting invariants in the code.

Whether Unity should throw an exception on a failure.

Asserts that the values are approximately equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f. Note: Every time you call the method with tolerance specified, a new instance of Assertions.Comparers.FloatComparer is created. For performance reasons you might want to instance your own comparer and pass it to the AreEqual method. If the tolerance is not specifies, a default comparer is used and the issue does not occur.

Tolerance of approximation.

Asserts that the values are equal. If no comparer is specified, EqualityComparer<T>.Default is used.

Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f.

Tolerance of approximation.

Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f.

Tolerance of approximation.

Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f.

Tolerance of approximation.

Asserts that the values are approximately not equal. An absolute error check is used for approximate equality check (|a-b| < tolerance). Default tolerance is 0.00001f.

Tolerance of approximation.

Asserts that the values are not equal.

Asserts that the condition is false.

Asserts that the value is not null.

Asserts that the value is null.

Asserts that the condition is true.

An exception that is thrown on a failure. Assertions.Assert._raiseExceptions needs to be set to true.

A float comparer used by Assertions.Assert performing approximate comparison.

Default epsilon used by the comparer.

Default instance of a comparer class with deafult error epsilon and absolute error check.

Performs equality check with absolute error check.

Expected value. Actual value. Comparison error. Result of the comparison.

Performs equality check with relative error check.

Expected value. Actual value. Comparison error. Result of the comparison.

Creates an instance of the comparer.

Should a relative check be used when comparing values? By default, an absolute check will be used. Allowed comparison error. By default, the FloatComparer.kEpsilon is used.

Creates an instance of the comparer.

Should a relative check be used when comparing values? By default, an absolute check will be used. Allowed comparison error. By default, the FloatComparer.kEpsilon is used.

Creates an instance of the comparer.

Should a relative check be used when comparing values? By default, an absolute check will be used. Allowed comparison error. By default, the FloatComparer.kEpsilon is used.

Creates an instance of the comparer.

Should a relative check be used when comparing values? By default, an absolute check will be used. Allowed comparison error. By default, the FloatComparer.kEpsilon is used.

An extension class that serves as a wrapper for the Assert class.

An extension method for Assertions.Assert.AreApproximatelyEqual.

An extension method for Assertions.Assert.AreEqual.

An extension method for Assertions.Assert.IsFalse.

An extension method for Assertions.Assert.IsNull.

An extension method for Assertions.Assert.IsTrue.

An extension method for Assertions.Assert.AreNotApproximatelyEqual.

An extension method for Assertions.Assert.AreNotEqual.

An extension method for Assertions.Assert.AreNotNull.

Asynchronous operation coroutine.

Allow scenes to be activated as soon as it is ready.

Event that is invoked upon operation completion. An event handler that is registered in the same frame as the call that creates it will be invoked next frame, even if the operation is able to complete synchronously. If a handler is registered after the operation has completed and has already invoked the complete event, the handler will be called synchronously.

Action<AsyncOperation> handler - function signature for completion event handler.

Has the operation finished? (Read Only)

Priority lets you tweak in which order async operation calls will be performed.

What's the operation's progress. (Read Only)

Type of the imported(native) data.

Acc - not supported.

Aiff.

iPhone hardware decoder, supports AAC, ALAC and MP3. Extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure.

Impulse tracker.

Protracker / Fasttracker MOD.

MP2/MP3 MPEG.

Ogg vorbis.

ScreamTracker 3.

3rd party / unknown plugin format.

VAG.

Microsoft WAV.

FastTracker 2 XM.

Xbox360 XMA.

Enumeration for SystemInfo.batteryStatus which represents the current status of the device's battery.

Device is plugged in and charging.

Device is unplugged and discharging.

Device is plugged in and the battery is full.

Device is plugged in, but is not charging.

The device's battery status cannot be determined. If battery status is not available on your target platform, SystemInfo.batteryStatus will return this value.

Use this BeforeRenderOrderAttribute when you need to specify a custom callback order for Application.onBeforeRender.

The order, lowest to highest, that the Application.onBeforeRender event recievers will be called in.

When applied to methods, specifies the order called during Application.onBeforeRender events.

The sorting order, sorted lowest to highest.

Behaviours are Components that can be enabled or disabled.

Enabled Behaviours are Updated, disabled Behaviours are not.

Has the Behaviour had enabled called.

BillboardAsset describes how a billboard is rendered.

Height of the billboard that is below ground.

Height of the billboard.

Number of pre-rendered images that can be switched when the billboard is viewed from different angles.

Number of indices in the billboard mesh.

The material used for rendering.

Number of vertices in the billboard mesh.

Width of the billboard.

Constructs a new BillboardAsset.

Get the array of billboard image texture coordinate data.

The list that receives the array.

Get the array of billboard image texture coordinate data.

The list that receives the array.

Get the indices of the billboard mesh.

The list that receives the array.

Get the indices of the billboard mesh.

The list that receives the array.

Get the vertices of the billboard mesh.

The list that receives the array.

Get the vertices of the billboard mesh.

The list that receives the array.

Set the array of billboard image texture coordinate data.

The array of data to set.

Set the array of billboard image texture coordinate data.

The array of data to set.

Set the indices of the billboard mesh.

The array of data to set.

Set the indices of the billboard mesh.

The array of data to set.

Set the vertices of the billboard mesh.

The array of data to set.

Set the vertices of the billboard mesh.

The array of data to set.

Renders a billboard from a BillboardAsset.

The BillboardAsset to render.

Constructor.

The BitStream class represents seralized variables, packed into a stream.

Is the BitStream currently being read? (Read Only)

Is the BitStream currently being written? (Read Only)

Serializes different types of variables.

Blend weights.

Four bones affect each vertex.

One bone affects each vertex.

Two bones affect each vertex.

Skinning bone weights of a vertex in the mesh.

Index of first bone.

Index of second bone.

Index of third bone.

Index of fourth bone.

Skinning weight for first bone.

Skinning weight for second bone.

Skinning weight for third bone.

Skinning weight for fourth bone.

Describes a single bounding sphere for use by a CullingGroup.

The position of the center of the BoundingSphere.

The radius of the BoundingSphere.

Initializes a BoundingSphere.

The center of the sphere. The radius of the sphere. A four-component vector containing the position (packed into the XYZ components) and radius (packed into the W component).

Initializes a BoundingSphere.

The center of the sphere. The radius of the sphere. A four-component vector containing the position (packed into the XYZ components) and radius (packed into the W component).

Represents an axis aligned bounding box.

The center of the bounding box.

The extents of the Bounding Box. This is always half of the size of the Bounds.

The maximal point of the box. This is always equal to center+extents.

The minimal point of the box. This is always equal to center-extents.

The total size of the box. This is always twice as large as the extents.

The closest point on the bounding box.

Arbitrary point. The point on the bounding box or inside the bounding box.

Is point contained in the bounding box?

Creates a new Bounds.

The location of the origin of the Bounds. The dimensions of the Bounds.

Grows the Bounds to include the point.

Grow the bounds to encapsulate the bounds.

Expand the bounds by increasing its size by amount along each side.

Does ray intersect this bounding box?

Does another bounding box intersect with this bounding box?

Sets the bounds to the min and max value of the box.

The smallest squared distance between the point and this bounding box.

Returns a nicely formatted string for the bounds.

Represents an axis aligned bounding box with all values as integers.

A BoundsInt.PositionCollection that contains all positions within the BoundsInt.

The center of the bounding box.

The maximal point of the box.

The minimal point of the box.

The position of the bounding box.

The total size of the box.

X value of the minimal point of the box.

The maximal x point of the box.

The minimal x point of the box.

Y value of the minimal point of the box.

The maximal y point of the box.

The minimal y point of the box.

Z value of the minimal point of the box.

The maximal z point of the box.

The minimal z point of the box.

Clamps the position and size of this bounding box to the given bounds.

Bounds to clamp to.

Is point contained in the bounding box?

Point to check. Whether the max limits are included in the check. Is point contained in the bounding box?

Is point contained in the bounding box?

Point to check. Whether the max limits are included in the check. Is point contained in the bounding box?

An iterator that allows you to iterate over all positions within the BoundsInt.

Current position of the enumerator.

Returns this as an iterator that allows you to iterate over all positions within the BoundsInt.

This BoundsInt.PositionEnumerator.

Moves the enumerator to the next position.

Whether the enumerator has successfully moved to the next position.

Resets this enumerator to its starting state.

Sets the bounds to the min and max value of the box.

Returns a nicely formatted string for the bounds.

Data structure for cache. Please refer to See Also:Caching.AddCache for more information.

The number of seconds that an AssetBundle may remain unused in the cache before it is automatically deleted.

Returns the index of the cache in the cache list.

Allows you to specify the total number of bytes that can be allocated for the cache.

Returns the path of the cache.

Returns true if the cache is readonly.

Returns true if the cache is ready.

Returns the number of currently unused bytes in the cache.

Returns the used disk space in bytes.

Returns true if the cache is valid.

Removes all cached content in the cache that has been cached by the current application.

The number of seconds that AssetBundles may remain unused in the cache. Returns True when cache clearing succeeded.

Removes all cached content in the cache that has been cached by the current application.

The number of seconds that AssetBundles may remain unused in the cache. Returns True when cache clearing succeeded.

Data structure for downloading AssetBundles to a customized cache path. See Also:UnityWebRequestAssetBundle.GetAssetBundle for more information.

Hash128 which is used as the version of the AssetBundle.

AssetBundle name which is used as the customized cache path.

The Caching class lets you manage cached AssetBundles, downloaded using UnityWebRequestAssetBundle.GetAssetBundle().

Returns the cache count in the cache list.

Controls compression of cache data. Enabled by default.

Gets or sets the current cache in which AssetBundles should be cached.

Returns the default cache which is added by Unity internally.

Returns true if Caching system is ready for use.

Add a cache with the given path.

Path to the cache folder.

Removes all the cached versions of the given AssetBundle from the cache.

The AssetBundle name. Returns true when cache clearing succeeded.

Removes all AssetBundle content that has been cached by the current application.

The number of seconds that AssetBundles may remain unused in the cache. True when cache clearing succeeded, false if cache was in use.

Removes all AssetBundle content that has been cached by the current application.

The number of seconds that AssetBundles may remain unused in the cache. True when cache clearing succeeded, false if cache was in use.

Removes the given version of the AssetBundle.

The AssetBundle name. Version needs to be cleaned. Returns true when cache clearing succeeded. Can return false if any cached bundle is in use.

Removes all the cached versions of the AssetBundle from the cache, except for the specified version.

The AssetBundle name. Version needs to be kept. Returns true when cache clearing succeeded.

Returns all paths of the cache in the cache list.

List of all the cache paths.

Returns the Cache at the given position in the cache list.

Index of the cache to get. A reference to the Cache at the index specified.

Returns the Cache that has the given cache path.

The cache path. A reference to the Cache with the given path.

Returns all cached versions of the given AssetBundle.

The AssetBundle name. List of all the cached version.

Checks if an AssetBundle is cached.

Url The filename of the AssetBundle. Domain and path information are stripped from this string automatically. Version The version number of the AssetBundle to check for. Negative values are not allowed. True if an AssetBundle matching the url and version parameters has previously been loaded using UnityWebRequestAssetBundle.GetAssetBundle() and is currently stored in the cache. Returns false if the AssetBundle is not in cache, either because it has been flushed from the cache or was never loaded using the Caching API.

Bumps the timestamp of a cached file to be the current time.

Moves the source Cache after the destination Cache in the cache list.

The Cache to move. The Cache which should come before the source Cache in the cache list.

Moves the source Cache before the destination Cache in the cache list.

The Cache to move. The Cache which should come after the source Cache in the cache list.

Removes the Cache from cache list.

The Cache to be removed. Returns true if the Cache is removed.

A Camera is a device through which the player views the world.

Gets the temporary RenderTexture target for this Camera.

The rendering path that is currently being used (Read Only).

Returns all enabled cameras in the scene.

The number of cameras in the current scene.

Dynamic Resolution Scaling.

High dynamic range rendering.

MSAA rendering.

Determines whether the stereo view matrices are suitable to allow for a single pass cull.

The aspect ratio (width divided by height).

The color with which the screen will be cleared.

Matrix that transforms from camera space to world space (Read Only).

Identifies what kind of camera this is.

How the camera clears the background.

Should the camera clear the stencil buffer after the deferred light pass?

Number of command buffers set up on this camera (Read Only).

This is used to render parts of the scene selectively.

Sets a custom matrix for the camera to use for all culling queries.

The camera we are currently rendering with, for low-level render control only (Read Only).

Camera's depth in the camera rendering order.

How and if camera generates a depth texture.

Mask to select which layers can trigger events on the camera.

The far clipping plane distance.

The field of view of the camera in degrees.

Should camera rendering be forced into a RenderTexture.

Per-layer culling distances.

How to perform per-layer culling for a Camera.

The first enabled camera tagged "MainCamera" (Read Only).

The near clipping plane distance.

Get or set the raw projection matrix with no camera offset (no jittering).

Event that is fired after any camera finishes rendering.

Event that is fired before any camera starts culling.

Event that is fired before any camera starts rendering.

Opaque object sorting mode.

Is the camera orthographic (true) or perspective (false)?

Camera's half-size when in orthographic mode.

How tall is the camera in pixels (not accounting for dynamic resolution scaling) (Read Only).

Where on the screen is the camera rendered in pixel coordinates.

How wide is the camera in pixels (not accounting for dynamic resolution scaling) (Read Only).

Get the view projection matrix used on the last frame.

Set a custom projection matrix.

Where on the screen is the camera rendered in normalized coordinates.

The rendering path that should be used, if possible.

How tall is the camera in pixels (accounting for dynamic resolution scaling) (Read Only).

How wide is the camera in pixels (accounting for dynamic resolution scaling) (Read Only).

If not null, the camera will only render the contents of the specified scene.

Returns the eye that is currently rendering. If called when stereo is not enabled it will return Camera.MonoOrStereoscopicEye.Mono. If called during a camera rendering callback such as OnRenderImage it will return the currently rendering eye. If called outside of a rendering callback and stereo is enabled, it will return the default eye which is Camera.MonoOrStereoscopicEye.Left.

Distance to a point where virtual eyes converge.

Stereoscopic rendering.

The distance between the virtual eyes. Use this to query or set the current eye separation. Note that most VR devices provide this value, in which case setting the value will have no effect.

Defines which eye of a VR display the Camera renders into.

Set the target display for this Camera.

Destination render texture.

An axis that describes the direction along which the distances of objects are measured for the purpose of sorting.

Transparent object sorting mode.

Should the jittered matrix be used for transparency rendering?

Whether or not the Camera will use occlusion culling during rendering.

Get the world-space speed of the camera (Read Only).

Matrix that transforms from world to camera space.

Add a command buffer to be executed at a specified place.

When to execute the command buffer during rendering. The buffer to execute.

Adds a command buffer to the GPU's async compute queues and executes that command buffer when graphics processing reaches a given point.

The point during the graphics processing at which this command buffer should commence on the GPU. The buffer to execute. The desired async compute queue type to execute the buffer on.

Given viewport coordinates, calculates the view space vectors pointing to the four frustum corners at the specified camera depth.

Normalized viewport coordinates to use for the frustum calculation. Z-depth from the camera origin at which the corners will be calculated. Camera eye projection matrix to use. Output array for the frustum corner vectors. Cannot be null and length must be >= 4.

Calculates and returns oblique near-plane projection matrix.

Vector4 that describes a clip plane. Oblique near-plane projection matrix.

Delegate type for camera callbacks.

Makes this camera's settings match other camera.

Copy camera settings to the other camera.

Sets the non-jittered projection matrix, sourced from the VR SDK.

Specifies the stereoscopic eye whose non-jittered projection matrix will be sourced from the VR SDK.

Fills an array of Camera with the current cameras in the scene, without allocating a new array.

An array to be filled up with cameras currently in the scene.

Get command buffers to be executed at a specified place.

When to execute the command buffer during rendering. Array of command buffers.

Gets the non-jittered projection matrix of a specific left or right stereoscopic eye.

Specifies the stereoscopic eye whose non-jittered projection matrix needs to be returned. The non-jittered projection matrix of the specified stereoscopic eye.

Gets the projection matrix of a specific left or right stereoscopic eye.

Specifies the stereoscopic eye whose projection matrix needs to be returned. The projection matrix of the specified stereoscopic eye.

Gets the left or right view matrix of a specific stereoscopic eye.

Specifies the stereoscopic eye whose view matrix needs to be returned. The view matrix of the specified stereoscopic eye.

A Camera eye corresponding to the left or right human eye for stereoscopic rendering, or neither for non-stereoscopic rendering. A single Camera can render both left and right views in a single frame. Therefore, this enum describes which eye the Camera is currently rendering when returned by Camera.stereoActiveEye during a rendering callback (such as Camera.OnRenderImage), or which eye to act on when passed into a function. The default value is Camera.MonoOrStereoscopicEye.Left, so Camera.MonoOrStereoscopicEye.Left may be returned by some methods or properties when called outside of rendering if stereoscopic rendering is enabled.

Camera eye corresponding to stereoscopic rendering of the left eye.

Camera eye corresponding to non-stereoscopic rendering.

Camera eye corresponding to stereoscopic rendering of the right eye.

Remove all command buffers set on this camera.

Remove command buffer from execution at a specified place.

When to execute the command buffer during rendering. The buffer to execute.

Remove command buffers from execution at a specified place.

When to execute the command buffer during rendering.

Render the camera manually.

Render into a static cubemap from this camera.

The cube map to render to. A bitmask which determines which of the six faces are rendered to. False if rendering fails, else true.

Render into a cubemap from this camera.

A bitfield indicating which cubemap faces should be rendered into. The texture to render to. False if rendering fails, else true.

Render one side of a stereoscopic 360-degree image into a cubemap from this camera.

The texture to render to. A bitfield indicating which cubemap faces should be rendered into. Set to the integer value 63 to render all faces. A Camera eye corresponding to the left or right eye for stereoscopic rendering, or neither for non-stereoscopic rendering. False if rendering fails, else true.

Render the camera with shader replacement.

Revert the aspect ratio to the screen's aspect ratio.

Make culling queries reflect the camera's built in parameters.

Make the projection reflect normal camera's parameters.

Remove shader replacement from camera.

Reset the camera to using the Unity computed projection matrices for all stereoscopic eyes.

Reset the camera to using the Unity computed view matrices for all stereoscopic eyes.

Resets this Camera's transparency sort settings to the default. Default transparency settings are taken from GraphicsSettings instead of directly from this Camera.

Make the rendering position reflect the camera's position in the scene.

Returns a ray going from camera through a screen point.

Transforms position from screen space into viewport space.

Transforms position from screen space into world space.

Make the camera render with shader replacement.

Sets a custom projection matrix for a specific stereoscopic eye.

Specifies the stereoscopic eye whose projection matrix needs to be set. The matrix to be set.

Sets a custom view matrix for a specific stereoscopic eye.

Specifies the stereoscopic view matrix to set. The matrix to be set.

Sets the Camera to render to the chosen buffers of one or more RenderTextures.

The RenderBuffer(s) to which color information will be rendered. The RenderBuffer to which depth information will be rendered.

Sets the Camera to render to the chosen buffers of one or more RenderTextures.

The RenderBuffer(s) to which color information will be rendered. The RenderBuffer to which depth information will be rendered.

Enum used to specify either the left or the right eye of a stereoscopic camera.

Specifies the target to be the left eye.

Specifies the target to be the right eye.

Returns a ray going from camera through a viewport point.

Transforms position from viewport space into screen space.

Transforms position from viewport space into world space.

The 3d vector in Viewport space. The 3d vector in World space.

Transforms position from world space into screen space.

Transforms position from world space into viewport space.

Values for Camera.clearFlags, determining what to clear when rendering a Camera.

Clear only the depth buffer.

Don't clear anything.

Clear with the skybox.

Clear with a background color.

Describes different types of camera.

Used to indicate a regular in-game camera.

Used to indicate a camera that is used for rendering previews in the Editor.

Used to indicate a camera that is used for rendering reflection probes.

Used to indicate that a camera is used for rendering the Scene View in the Editor.

Used to indicate that a camera is used for rendering VR (in edit mode) in the Editor.

Representation of RGBA colors.

Alpha component of the color (0 is transparent, 1 is opaque).

Blue component of the color.

Solid black. RGBA is (0, 0, 0, 1).

Solid blue. RGBA is (0, 0, 1, 1).

Completely transparent. RGBA is (0, 0, 0, 0).

Cyan. RGBA is (0, 1, 1, 1).

Green component of the color.

A version of the color that has had the gamma curve applied.

Gray. RGBA is (0.5, 0.5, 0.5, 1).

The grayscale value of the color. (Read Only)

Solid green. RGBA is (0, 1, 0, 1).

English spelling for gray. RGBA is the same (0.5, 0.5, 0.5, 1).

A linear value of an sRGB color.

Magenta. RGBA is (1, 0, 1, 1).

Returns the maximum color component value: Max(r,g,b).

Red component of the color.

Solid red. RGBA is (1, 0, 0, 1).

Solid white. RGBA is (1, 1, 1, 1).

Yellow. RGBA is (1, 0.92, 0.016, 1), but the color is nice to look at!

Constructs a new Color with given r,g,b,a components.

Red component. Green component. Blue component. Alpha component.

Constructs a new Color with given r,g,b components and sets a to 1.

Red component. Green component. Blue component.

Creates an RGB colour from HSV input.

Hue [0..1]. Saturation [0..1]. Value [0..1]. Output HDR colours. If true, the returned colour will not be clamped to [0..1]. An opaque colour with HSV matching the input.

Creates an RGB colour from HSV input.

Hue [0..1]. Saturation [0..1]. Value [0..1]. Output HDR colours. If true, the returned colour will not be clamped to [0..1]. An opaque colour with HSV matching the input.

Colors can be implicitly converted to and from Vector4.

Linearly interpolates between colors a and b by t.

Color a Color b Float for combining a and b

Linearly interpolates between colors a and b by t.

Divides color a by the float b. Each color component is scaled separately.

Subtracts color b from color a. Each component is subtracted separately.

Multiplies two colors together. Each component is multiplied separately.

Multiplies color a by the float b. Each color component is scaled separately.

Adds two colors together. Each component is added separately.

Calculates the hue, saturation and value of an RGB input color.

An input color. Output variable for hue. Output variable for saturation. Output variable for value.

Access the r, g, b,a components using [0], [1], [2], [3] respectively.

Returns a nicely formatted string of this color.

Representation of RGBA colors in 32 bit format.

Alpha component of the color.

Blue component of the color.

Green component of the color.

Red component of the color.

Constructs a new Color32 with given r, g, b, a components.

Color32 can be implicitly converted to and from Color.

Linearly interpolates between colors a and b by t.

Returns a nicely formatted string of this color.

Represents a color gamut.

sRGB color gamut.

Display-P3 color gamut.

DolbyHDR high dynamic range color gamut.

HDR10 high dynamic range color gamut.

Rec. 2020 color gamut.

Rec. 709 color gamut.

Color space for player settings.

Gamma color space.

Linear color space.

Uninitialized color space.

Attribute used to configure the usage of the ColorField and Color Picker for a color.

If set to true the Color is treated as a HDR color.

Maximum allowed HDR color component value when using the HDR Color Picker.

Maximum exposure value allowed in the HDR Color Picker.

Minimum allowed HDR color component value when using the Color Picker.

Minimum exposure value allowed in the HDR Color Picker.

If false then the alpha bar is hidden in the ColorField and the alpha value is not shown in the Color Picker.

Attribute for Color fields. Used for configuring the GUI for the color.

If false then the alpha channel info is hidden both in the ColorField and in the Color Picker. Set to true if the color should be treated as a HDR color (default value: false). Minimum allowed HDR color component value when using the HDR Color Picker (default value: 0). Maximum allowed HDR color component value when using the HDR Color Picker (default value: 8). Minimum exposure value allowed in the HDR Color Picker (default value: 1/8 = 0.125). Maximum exposure value allowed in the HDR Color Picker (default value: 3).

Attribute for Color fields. Used for configuring the GUI for the color.

A collection of common color functions.

Returns the color as a hexadecimal string in the format "RRGGBB".

The color to be converted. Hexadecimal string representing the color.

Returns the color as a hexadecimal string in the format "RRGGBBAA".

The color to be converted. Hexadecimal string representing the color.

Attempts to convert a html color string.

Case insensitive html string to be converted into a color. The converted color. True if the string was successfully converted else false.

Struct used to describe meshes to be combined using Mesh.CombineMeshes.

The baked lightmap UV scale and offset applied to the Mesh.

Mesh to combine.

The realtime lightmap UV scale and offset applied to the Mesh.

Sub-Mesh index of the Mesh.

Matrix to transform the Mesh with before combining.

Interface into compass functionality.

Used to enable or disable compass. Note, that if you want Input.compass.trueHeading property to contain a valid value, you must also enable location updates by calling Input.location.Start().

Accuracy of heading reading in degrees.

The heading in degrees relative to the magnetic North Pole. (Read Only)

The raw geomagnetic data measured in microteslas. (Read Only)

Timestamp (in seconds since 1970) when the heading was last time updated. (Read Only)

The heading in degrees relative to the geographic North Pole. (Read Only)

Base class for everything attached to GameObjects.

The game object this component is attached to. A component is always attached to a game object.

The tag of this game object.

The Transform attached to this GameObject.

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Name of the method to call. Optional parameter to pass to the method (can be any value). Should an error be raised if the method does not exist for a given target object?

Is this game object tagged with tag ?

The tag to compare.

Returns the component of Type type if the game object has one attached, null if it doesn't.

The type of Component to retrieve.

Generic version. See the page for more details.

Returns the component with name type if the game object has one attached, null if it doesn't.

Returns the component of Type type in the GameObject or any of its children using depth first search.

The type of Component to retrieve. A component of the matching type, if found.

Generic version. See the page for more details.

A component of the matching type, if found.

Returns the component of Type type in the GameObject or any of its parents.

The type of Component to retrieve. A component of the matching type, if found.

Generic version. See the page for more details.

A component of the matching type, if found.

Returns all components of Type type in the GameObject.

The type of Component to retrieve.

Generic version. See the page for more details.

Returns all components of Type type in the GameObject or any of its children.

The type of Component to retrieve. Should Components on inactive GameObjects be included in the found set? includeInactive decides which children of the GameObject will be searched. The GameObject that you call GetComponentsInChildren on is always searched regardless.

Returns all components of Type type in the GameObject or any of its children.

Generic version. See the page for more details.

Should Components on inactive GameObjects be included in the found set? includeInactive decides which children of the GameObject will be searched. The GameObject that you call GetComponentsInChildren on is always searched regardless. A list of all found components matching the specified type.

Generic version. See the page for more details.

A list of all found components matching the specified type.

Returns all components of Type type in the GameObject or any of its parents.

The type of Component to retrieve. Should inactive Components be included in the found set?

Generic version. See the page for more details.

Should inactive Components be included in the found set?

Generic version. See the page for more details.

Should inactive Components be included in the found set?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object.

Name of the method to call. Optional parameter for the method. Should an error be raised if the target object doesn't implement the method for the message?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

Name of method to call. Optional parameter value for the method. Should an error be raised if the method does not exist on the target object?

GPU data buffer, mostly for use with compute shaders.

Number of elements in the buffer (Read Only).

Size of one element in the buffer (Read Only).

Copy counter value of append/consume buffer into another buffer.

Append/consume buffer to copy the counter from. A buffer to copy the counter to. Target byte offset in dst.

Create a Compute Buffer.

Number of elements in the buffer. Size of one element in the buffer. Has to match size of buffer type in the shader. See for cross-platform compatibility information. Type of the buffer, default is ComputeBufferType.Default (structured buffer).

Create a Compute Buffer.

Read data values from the buffer into an array.

An array to receive the data.

Partial read of data values from the buffer into an array.

An array to receive the data. The first element index in data where retrieved elements are copied. The first element index of the compute buffer from which elements are read. The number of elements to retrieve.

Retrieve a native (underlying graphics API) pointer to the buffer.

Pointer to the underlying graphics API buffer.

Returns true if this compute buffer is valid and false otherwise.

Release a Compute Buffer.

Sets counter value of append/consume buffer.

Value of the append/consume counter.

Set the buffer with values from an array.

Array of values to fill the buffer.

Partial copy of data values from an array into the buffer.

Array of values to fill the buffer. The first element index in data to copy to the compute buffer. The first element index in compute buffer to receive the data. The number of elements to copy.

ComputeBuffer type.

Append-consume ComputeBuffer type.

ComputeBuffer with a counter.

Default ComputeBuffer type (structured buffer).

ComputeBuffer used for Graphics.DrawProceduralIndirect, ComputeShader.DispatchIndirect or Graphics.DrawMeshInstancedIndirect arguments.

Raw ComputeBuffer type (byte address buffer).

Compute Shader asset.

Execute a compute shader.

Which kernel to execute. A single compute shader asset can have multiple kernel entry points. Number of work groups in the X dimension. Number of work groups in the Y dimension. Number of work groups in the Z dimension.

Execute a compute shader.

Which kernel to execute. A single compute shader asset can have multiple kernel entry points. Buffer with dispatch arguments. The byte offset into the buffer, where the draw arguments start.

Find ComputeShader kernel index.

Name of kernel function. The Kernel index, or logs a "FindKernel failed" error message if the kernel is not found.

Get kernel thread group sizes.

Which kernel to query. A single compute shader asset can have multiple kernel entry points. Thread group size in the X dimension. Thread group size in the Y dimension. Thread group size in the Z dimension.

Checks whether a shader contains a given kernel.

The name of the kernel to look for. True if the kernel is found, false otherwise.

Set a bool parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a bool parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Sets an input or output compute buffer.

For which kernel the buffer is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Buffer to set.

Sets an input or output compute buffer.

For which kernel the buffer is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Buffer to set.

Set a float parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a float parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set multiple consecutive float parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set multiple consecutive float parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set an integer parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set an integer parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set multiple consecutive integer parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set multiple consecutive integer parameters at once.

Array variable name in the shader code. Property name ID, use Shader.PropertyToID to get it. Value array to set.

Set a Matrix parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a Matrix parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a Matrix array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a Matrix array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a texture parameter.

For which kernel the texture is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Texture to set.

Set a texture parameter.

For which kernel the texture is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Texture to set.

Set a texture parameter from a global texture property.

For which kernel the texture is being set. See FindKernel. Property name ID, use Shader.PropertyToID to get it. Name of the buffer variable in shader code. Global texture property to assign to shader. Property name ID, use Shader.PropertyToID to get it.

Set a texture parameter from a global texture property.

Set a vector parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a vector parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a vector array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

Set a vector array parameter.

Variable name in shader code. Property name ID, use Shader.PropertyToID to get it. Value to set.

The various test results the connection tester may return with.

Some unknown error occurred.

Port-restricted NAT type, can do NAT punchthrough to everyone except symmetric.

Symmetric NAT type, cannot do NAT punchthrough to other symmetric types nor port restricted type.

Address-restricted cone type, NAT punchthrough fully supported.

Full cone type, NAT punchthrough fully supported.

Public IP address detected and game listen port is accessible to the internet.

Public IP address detected but server is not initialized and no port is listening.

Public IP address detected but the port is not connectable from the internet.

Test result undetermined, still in progress.

The ContextMenu attribute allows you to add commands to the context menu.

Adds the function to the context menu of the component.

The name of the context menu item. Whether this is a validate function (defaults to false). Priority used to override the ordering of the menu items (defaults to 1000000). The lower the number the earlier in the menu it will appear.

Adds the function to the context menu of the component.

Use this attribute to add a context menu to a field that calls a named method.

The name of the function that should be called.

The name of the context menu item.

Use this attribute to add a context menu to a field that calls a named method.

The name of the context menu item. The name of the function that should be called.

MonoBehaviour.StartCoroutine returns a Coroutine. Instances of this class are only used to reference these coroutines, and do not hold any exposed properties or functions.

Holds data for a single application crash event and provides access to all gathered crash reports.

Returns last crash report, or null if no reports are available.

Returns all currently available reports in a new array.

Crash report data as formatted text.

Time, when the crash occured.

Remove report from available reports list.

Remove all reports from available reports list.

Mark a ScriptableObject-derived type to be automatically listed in the Assets/Create submenu, so that instances of the type can be easily created and stored in the project as ".asset" files.

The default file name used by newly created instances of this type.

The display name for this type shown in the Assets/Create menu.

The position of the menu item within the Assets/Create menu.

Class for handling cube maps, Use this to create or modify existing.

The format of the pixel data in the texture (Read Only).

How many mipmap levels are in this texture (Read Only).

Actually apply all previous SetPixel and SetPixels changes.

When set to true, mipmap levels are recalculated. When set to true, system memory copy of a texture is released.

Creates a Unity cubemap out of externally created native cubemap object.

The width and height of each face of the cubemap should be the same. Format of underlying cubemap object. Does the cubemap have mipmaps? Native cubemap texture object.

Create a new empty cubemap texture.

Width/height of a cube face in pixels. Pixel data format to be used for the Cubemap. Should mipmaps be created?

Returns pixel color at coordinates (face, x, y).

Returns pixel colors of a cubemap face.

The face from which pixel data is taken. Mipmap level for the chosen face.

Sets pixel color at coordinates (face, x, y).

Sets pixel colors of a cubemap face.

Pixel data for the Cubemap face. The face to which the new data should be applied. The mipmap level for the face.

Performs smoothing of near edge regions.

Pixel distance at edges over which to apply smoothing.

Class for handling Cubemap arrays.

Number of cubemaps in the array (Read Only).

Texture format (Read Only).

Actually apply all previous SetPixels changes.

When set to true, mipmap levels are recalculated. When set to true, system memory copy of a texture is released.

Create a new cubemap array.

Cubemap face size in pixels. Number of elements in the cubemap array. Format of the pixel data. Should mipmaps be created? Does the texture contain non-color data (i.e. don't do any color space conversions when sampling)? Default is false.

Create a new cubemap array.

Returns pixel colors of a single array slice/face.

Cubemap face to read pixels from. Array slice to read pixels from. Mipmap level to read pixels from. Array of pixel colors.

Returns pixel colors of a single array slice/face.

Cubemap face to read pixels from. Array slice to read pixels from. Mipmap level to read pixels from. Array of pixel colors in low precision (8 bits/channel) format.

Set pixel colors for a single array slice/face.

An array of pixel colors. Cubemap face to set pixels for. Array element index to set pixels for. Mipmap level to set pixels for.

Set pixel colors for a single array slice/face.

An array of pixel colors in low precision (8 bits/channel) format. Cubemap face to set pixels for. Array element index to set pixels for. Mipmap level to set pixels for.

Cubemap face.

Left facing side (-x).

Downward facing side (-y).

Backward facing side (-z).

Right facing side (+x).

Upwards facing side (+y).

Forward facing side (+z).

Cubemap face is unknown or unspecified.

Describes a set of bounding spheres that should have their visibility and distances maintained.

Pauses culling group execution.

Sets the callback that will be called when a sphere's visibility and/or distance state has changed.

Locks the CullingGroup to a specific camera.

Create a CullingGroup.

Clean up all memory used by the CullingGroup immediately.

Erase a given bounding sphere by moving the final sphere on top of it.

The index of the entry to erase.

Erase a given entry in an arbitrary array by copying the final entry on top of it, then decrementing the number of entries used by one.

The index of the entry to erase. An array of entries. The number of entries in the array that are actually used.

Get the current distance band index of a given sphere.

The index of the sphere. The sphere's current distance band index.

Returns true if the bounding sphere at index is currently visible from any of the contributing cameras.

The index of the bounding sphere. True if the sphere is visible; false if it is invisible.

Retrieve the indices of spheres that have particular visibility and/or distance states.

True if only visible spheres should be retrieved; false if only invisible spheres should be retrieved. The distance band that retrieved spheres must be in. An array that will be filled with the retrieved sphere indices. The index of the sphere to begin searching at. The number of sphere indices found and written into the result array.

Retrieve the indices of spheres that have particular visibility and/or distance states.

Set bounding distances for 'distance bands' the group should compute, as well as options for how spheres falling into each distance band should be treated.

An array of bounding distances. The distances should be sorted in increasing order. An array of CullingDistanceBehaviour settings. The array should be the same length as the array provided to the distances parameter. It can also be omitted or passed as null, in which case all distances will be given CullingDistanceBehaviour.Normal behaviour.

Sets the number of bounding spheres in the bounding spheres array that are actually being used.

The number of bounding spheres being used.

Sets the array of bounding sphere definitions that the CullingGroup should compute culling for.

The BoundingSpheres to cull.

Set the reference point from which distance bands are measured.

A fixed point to measure the distance from. A transform to measure the distance from. The transform's position will be automatically tracked.

Set the reference point from which distance bands are measured.

A fixed point to measure the distance from. A transform to measure the distance from. The transform's position will be automatically tracked.

This delegate is used for recieving a callback when a sphere's distance or visibility state has changed.

A CullingGroupEvent that provides information about the sphere that has changed.

Provides information about the current and previous states of one sphere in a CullingGroup.

The current distance band index of the sphere, after the most recent culling pass.

Did this sphere change from being visible to being invisible in the most recent culling pass?

Did this sphere change from being invisible to being visible in the most recent culling pass?

The index of the sphere that has changed.

Was the sphere considered visible by the most recent culling pass?

The distance band index of the sphere before the most recent culling pass.

Was the sphere visible before the most recent culling pass?

Cursor API for setting the cursor (mouse pointer).

Determines whether the hardware pointer is locked to the center of the view, constrained to the window, or not constrained at all.

Determines whether the hardware pointer is visible or not.

Sets the mouse cursor to the given texture.

Specify a custom cursor that you wish to use as a cursor.

The texture to use for the cursor or null to set the default cursor. Note that a texture needs to be imported with "Read/Write enabled" in the texture importer (or using the "Cursor" defaults), in order to be used as a cursor. The offset from the top left of the texture to use as the target point (must be within the bounds of the cursor). Allow this cursor to render as a hardware cursor on supported platforms, or force software cursor.

How the cursor should behave.

Confine cursor to the game window.

Lock cursor to the center of the game window.

Cursor behavior is unmodified.

Determines whether the mouse cursor is rendered using software rendering or, on supported platforms, hardware rendering.

Use hardware cursors on supported platforms.

Force the use of software cursors.

Custom Render Textures are an extension to Render Textures, enabling you to render directly to the Texture using a Shader.

Bitfield that allows to enable or disable update on each of the cubemap faces. Order from least significant bit is +X, -X, +Y, -Y, +Z, -Z.

If true, the Custom Render Texture is double buffered so that you can access it during its own update. otherwise the Custom Render Texture will be not be double buffered.

Color with which the Custom Render Texture is initialized. This parameter will be ignored if an initializationMaterial is set.

Material with which the Custom Render Texture is initialized. Initialization texture and color are ignored if this parameter is set.

Specify how the texture should be initialized.

Specify if the texture should be initialized with a Texture and a Color or a Material.

Texture with which the Custom Render Texture is initialized (multiplied by the initialization color). This parameter will be ignored if an initializationMaterial is set.

Material with which the content of the Custom Render Texture is updated.

Shader Pass used to update the Custom Render Texture.

Specify how the texture should be updated.

Space in which the update zones are expressed (Normalized or Pixel space).

If true, Update zones will wrap around the border of the Custom Render Texture. Otherwise, Update zones will be clamped at the border of the Custom Render Texture.

Clear all Update Zones.

Create a new Custom Render Texture.

Returns the list of Update Zones.

Output list of Update Zones.

Triggers an initialization of the Custom Render Texture.

Setup the list of Update Zones for the Custom Render Texture.

Triggers the update of the Custom Render Texture.

Number of upate pass to perform.

Specify the source of a Custom Render Texture initialization.

Custom Render Texture is initalized with a Material.

Custom Render Texture is initialized by a Texture multiplied by a Color.

Frequency of update or initialization of a Custom Render Texture.

Initialization/Update will only occur when triggered by the script.

Initialization/Update will occur once at load time and then can be triggered again by script.

Initialization/Update will occur at every frame.

Structure describing an Update Zone.

If true, and if the texture is double buffered, a request is made to swap the buffers before the next update. Otherwise, the buffers will not be swapped.

Shader Pass used to update the Custom Render Texture for this Update Zone.

Rotation of the Update Zone.

Position of the center of the Update Zone within the Custom Render Texture.

Size of the Update Zone.

Space in which coordinates are provided for Update Zones.

Coordinates are normalized. (0, 0) is top left and (1, 1) is bottom right.

Coordinates are expressed in pixels. (0, 0) is top left (width, height) is bottom right.

Base class for custom yield instructions to suspend coroutines.

Indicates if coroutine should be kept suspended.

Class containing methods to ease debugging while developing a game.

Reports whether the development console is visible. The development console cannot be made to appear using:

In the Build Settings dialog there is a check box called "Development Build".

Get default debug logger.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs an error message to the Unity console on failure.

Condition you expect to be true. Object to which the message applies. String or object to be converted to string representation for display.

Assert a condition and logs a formatted error message to the Unity console on failure.

Condition you expect to be true. A composite format string. Format arguments. Object to which the message applies.

Assert a condition and logs a formatted error message to the Unity console on failure.

Condition you expect to be true. A composite format string. Format arguments. Object to which the message applies.

Pauses the editor.

Clears errors from the developer console.

Draws a line between specified start and end points.

Point in world space where the line should start. Point in world space where the line should end. Color of the line. How long the line should be visible for. Should the line be obscured by objects closer to the camera?

Draws a line between specified start and end points.

Draws a line from start to start + dir in world coordinates.

Point in world space where the ray should start. Direction and length of the ray. Color of the drawn line. How long the line will be visible for (in seconds). Should the line be obscured by other objects closer to the camera?

Draws a line from start to start + dir in world coordinates.

Logs message to the Unity Console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs message to the Unity Console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs an assertion message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs an assertion message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs a formatted assertion message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted assertion message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

A variant of Debug.Log that logs an error message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs an error message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs a formatted error message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted error message to the Unity console.

A composite format string. Format arguments. Object to which the message applies.

A variant of Debug.Log that logs an error message to the console.

Object to which the message applies. Runtime Exception.

A variant of Debug.Log that logs an error message to the console.

Object to which the message applies. Runtime Exception.

Logs a formatted message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

A variant of Debug.Log that logs a warning message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

A variant of Debug.Log that logs a warning message to the console.

String or object to be converted to string representation for display. Object to which the message applies.

Logs a formatted warning message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

Logs a formatted warning message to the Unity Console.

A composite format string. Format arguments. Object to which the message applies.

Attribute used to make a float, int, or string variable in a script be delayed.

Depth texture generation mode for Camera.

Generate a depth texture.

Generate a depth + normals texture.

Specifies whether motion vectors should be rendered (if possible).

Do not generate depth texture (Default).

Describes physical orientation of the device as determined by the OS.

The device is held parallel to the ground with the screen facing downwards.

The device is held parallel to the ground with the screen facing upwards.

The device is in landscape mode, with the device held upright and the home button on the right side.

The device is in landscape mode, with the device held upright and the home button on the left side.

The device is in portrait mode, with the device held upright and the home button at the bottom.

The device is in portrait mode but upside down, with the device held upright and the home button at the top.

The orientation of the device cannot be determined.

Enumeration for SystemInfo.deviceType, denotes a coarse grouping of kinds of devices.

A stationary gaming console.

Desktop or laptop computer.

A handheld device like mobile phone or a tablet.

Device type is unknown. You should never see this in practice.

Prevents MonoBehaviour of same type (or subtype) to be added more than once to a GameObject.

Provides access to a display / screen for rendering operations.

Gets the state of the display and returns true if the display is active and false if otherwise.

Color RenderBuffer.

Depth RenderBuffer.

The list of currently connected Displays. Contains at least one (main) display.

Main Display.

Vertical resolution that the display is rendering at.

Horizontal resolution that the display is rendering at.

Vertical native display resolution.

Horizontal native display resolution.

Activate an external display. Eg. Secondary Monitors connected to the System.

This overloaded function available for Windows allows specifying desired Window Width, Height and Refresh Rate.

Desired Width of the Window (for Windows only. On Linux and Mac uses Screen Width). Desired Height of the Window (for Windows only. On Linux and Mac uses Screen Height). Desired Refresh Rate.

Query relative mouse coordinates.

Mouse Input Position as Coordinates.

Set rendering size and position on screen (Windows only).

Change Window Width (Windows Only). Change Window Height (Windows Only). Change Window Position X (Windows Only). Change Window Position Y (Windows Only).

Sets rendering resolution for the display.

Rendering width in pixels. Rendering height in pixels.

A component can be designed to drive a RectTransform. The DrivenRectTransformTracker struct is used to specify which RectTransforms it is driving.

Add a RectTransform to be driven.

The object to drive properties. The RectTransform to be driven. The properties to be driven.

Clear the list of RectTransforms being driven.

An enumeration of transform properties that can be driven on a RectTransform by an object.

Selects all driven properties.

Selects driven property RectTransform.anchoredPosition.

Selects driven property RectTransform.anchoredPosition3D.

Selects driven property RectTransform.anchoredPosition.x.

Selects driven property RectTransform.anchoredPosition.y.

Selects driven property RectTransform.anchoredPosition3D.z.

Selects driven property combining AnchorMaxX and AnchorMaxY.

Selects driven property RectTransform.anchorMax.x.

Selects driven property RectTransform.anchorMax.y.

Selects driven property combining AnchorMinX and AnchorMinY.

Selects driven property RectTransform.anchorMin.x.

Selects driven property RectTransform.anchorMin.y.

Selects driven property combining AnchorMinX, AnchorMinY, AnchorMaxX and AnchorMaxY.

Deselects all driven properties.

Selects driven property combining PivotX and PivotY.

Selects driven property RectTransform.pivot.x.

Selects driven property RectTransform.pivot.y.

Selects driven property Transform.localRotation.

Selects driven property combining ScaleX, ScaleY && ScaleZ.

Selects driven property Transform.localScale.x.

Selects driven property Transform.localScale.y.

Selects driven property Transform.localScale.z.

Selects driven property combining SizeDeltaX and SizeDeltaY.

Selects driven property RectTransform.sizeDelta.x.

Selects driven property RectTransform.sizeDelta.y.

Allows to control the dynamic Global Illumination.

Allows for scaling the contribution coming from realtime & static lightmaps.

Is precomputed realtime Global Illumination output converged?

When enabled, new dynamic Global Illumination output is shown in each frame.

Threshold for limiting updates of realtime GI. The unit of measurement is "percentage intensity change".

Allows to set an emissive color for a given renderer quickly, without the need to render the emissive input for the entire system.

The Renderer that should get a new color. The emissive Color.

Allows overriding the distant environment lighting for Realtime GI, without changing the Skybox Material.

Array of float values to be used for Realtime GI environment lighting.

Schedules an update of the environment texture.

Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain.

The Renderer to use when searching for a system to update. The Terrain to use when searching for systems to update.

Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain.

The Renderer to use when searching for a system to update. The Terrain to use when searching for systems to update.

Schedules an update of the albedo and emissive textures of a system that contains the renderer or the terrain.

The Renderer to use when searching for a system to update. The Terrain to use when searching for systems to update.

THe mode that a listener is operating in.

The listener will bind to one argument bool functions.

The listener will use the function binding specified by the even.

The listener will bind to one argument float functions.

The listener will bind to one argument int functions.

The listener will bind to one argument Object functions.

The listener will bind to one argument string functions.

The listener will bind to zero argument functions.

Zero argument delegate used by UnityEvents.

One argument delegate used by UnityEvents.

Two argument delegate used by UnityEvents.

Three argument delegate used by UnityEvents.

Four argument delegate used by UnityEvents.

A zero argument persistent callback that can be saved with the scene.

Add a non persistent listener to the UnityEvent.

Callback function.

Constructor.

Invoke all registered callbacks (runtime and persistent).

Remove a non persistent listener from the UnityEvent.

Callback function.

One argument version of UnityEvent.

Two argument version of UnityEvent.

Three argument version of UnityEvent.

Four argument version of UnityEvent.

Abstract base class for UnityEvents.

Get the number of registered persistent listeners.

Get the target method name of the listener at index index.

Index of the listener to query.

Get the target component of the listener at index index.

Index of the listener to query.

Given an object, function name, and a list of argument types; find the method that matches.

Object to search for the method. Function name to search for. Argument types for the function.

Remove all non-persisent (ie created from script) listeners from the event.

Modify the execution state of a persistent listener.

Index of the listener to query. State to set.

Controls the scope of UnityEvent callbacks.

Callback is always issued.

Callback is not issued.

Callback is only issued in the Runtime and Editor playmode.

Add this attribute to a class to prevent the class and its inherited classes from being created with ObjectFactory methods.

Default constructor.

Add this attribute to a class to prevent creating a Preset from the instances of the class.

Makes all instances of a script execute in edit mode.

A helper structure used to initialize a LightDataGI structure as a directional light.

The direct light color.

The direction of the light.

The indirect light color.

The light's instanceID.

The lightmode.

The penumbra width for soft shadows in radians.

True if the light casts shadows, otherwise False.

Available falloff models for baking.

Inverse squared distance falloff model.

Inverse squared distance falloff model (without smooth range attenuation).

Quadratic falloff model.

Linear falloff model.

Falloff model is undefined.

The interop structure to pass light information to the light baking backends. There are helper structures for Directional, Point, Spot and Rectangle lights to correctly initialize this structure.

The color of the light.

The cone angle for spot lights.

The falloff model to use for baking point and spot lights.

The indirect color of the light.

The inner cone angle for spot lights.

The light's instanceID.

The lightmap mode for the light.

The orientation of the light.

The position of the light.

The range of the light. Unused for directional lights.

Set to 1 for shadow casting lights, 0 otherwise.

The light's sphere radius for point and spot lights, or the width for rectangle lights.

The height for rectangle lights.

The type of the light.

Initialize the struct with the parameters from the given light type.

Initialize a light so that the baking backends ignore it.

Utility class for converting Unity Lights to light types recognized by the baking backends.

Extracts informations from Lights.

The lights baketype. Returns the light's light mode.

Extract type specific information from Lights.

The input light. Extracts directional light information. Extracts point light information. Extracts spot light information. Extracts rectangle light information.

Extract type specific information from Lights.

The input light. Extracts directional light information. Extracts point light information. Extracts spot light information. Extracts rectangle light information.

Extract type specific information from Lights.

The input light. Extracts directional light information. Extracts point light information. Extracts spot light information. Extracts rectangle light information.

Extract type specific information from Lights.

The input light. Extracts directional light information. Extracts point light information. Extracts spot light information. Extracts rectangle light information.

Extracts the indirect color from a light.

Extracts the inner cone angle of spot lights.

Interface to the light baking backends.

Delegate called when converting lights into a form that the baking backends understand.

The list of lights to be converted. The output generated by the delegate function. Lights that should be skipped must be added to the output, initialized with InitNoBake on the LightDataGI structure.

Resets the light conversion delegate to Unity's default conversion function.

Set a delegate that converts a list of lights to a list of LightDataGI structures that are passed to the baking backends. Must be reset by calling ResetDelegate again.

The lightmode. A light can be realtime, mixed, baked or unknown. Unknown lights will be ignored by the baking backends.

The light is fully baked and has no realtime component.

The light is mixed. Mixed lights are interpreted based on the global light mode setting in the lighting window.

The light is realtime. No contribution will be baked in lightmaps or light probes.

The light should be ignored by the baking backends.

The light type.

An infinite directional light.

A point light emitting light in all directions.

A light shaped like a rectangle emitting light into the hemisphere that it is facing.

A spot light emitting light in a direction with a cone shaped opening angle.

Contains normalized linear color values for red, green, blue in the range of 0 to 1, and an additional intensity value.

The blue color value in the range of 0.0 to 1.0.

The green color value in the range of 0.0 to 1.0.

The intensity value used to scale the red, green and blue values.

The red color value in the range of 0.0 to 1.0.

Returns a black color.

Converts a Light's color value to a normalized linear color value, automatically handling gamma conversion if necessary.

Light color. Light intensity. Returns the normalized linear color value.

A helper structure used to initialize a LightDataGI structure as a point light.

The direct light color.

The falloff model to use for baking the point light.

The indirect light color.

The light's instanceID.

The lightmode.

The light's position.

The light's range.

True if the light casts shadows, otherwise False.

The light's sphere radius, influencing soft shadows.

A helper structure used to initialize a LightDataGI structure as a rectangle light.

The direct light color.

The height of the rectangle light.

The indirect light color.

The light's instanceID.

The lightmode.

The light's orientation.

The light's position.

The light's range.

True if the light casts shadows, otherwise False.

The width of the rectangle light.

A helper structure used to initialize a LightDataGI structure as a spot light.

The direct light color.

The outer angle for the spot light.

The falloff model to use for baking the spot light.

The indirect light color.

The inner angle for the spot light.

The light's instanceID.

The lightmode.

The light's orientation.

The light's position.

The light's range.

True if the light casts shadows, otherwise False.

The light's sphere radius, influencing soft shadows.

The class representing the player loop in Unity.

Returns the default update order of all engine systems in Unity.

Set a new custom update order of all engine systems in Unity.

The representation of a single system being updated by the player loop in Unity.

The loop condition for a native engine system. To get a valid value for this, you must copy it from one of the PlayerLoopSystems returned by PlayerLoop.GetDefaultPlayerLoop.

A list of sub systems which run as part of this item in the player loop.

This property is used to identify which native system this belongs to, or to get the name of the managed system to show in the profiler.

A managed delegate. You can set this to create a new C# entrypoint in the player loop.

A native engine system. To get a valid value for this, you must copy it from one of the PlayerLoopSystems returned by PlayerLoop.GetDefaultPlayerLoop.

An implementation of IPlayable that produces a Camera texture.

Creates a CameraPlayable in the PlayableGraph.

The PlayableGraph object that will own the CameraPlayable. Camera used to produce a texture in the PlayableGraph. A CameraPlayable linked to the PlayableGraph.

An implementation of IPlayable that allows application of a Material shader to one or many texture inputs to produce a texture output.

Creates a MaterialEffectPlayable in the PlayableGraph.

The PlayableGraph object that will own the MaterialEffectPlayable. Material used to modify linked texture playable inputs. Shader pass index.(Note: -1 for all passes). A MaterialEffectPlayable linked to the PlayableGraph.

An implementation of IPlayable that allows mixing two textures.

Creates a TextureMixerPlayable in the PlayableGraph.

The PlayableGraph object that will own the TextureMixerPlayable. A TextureMixerPlayable linked to the PlayableGraph.

An IPlayableOutput implementation that will be used to manipulate textures.

Returns an invalid TexturePlayableOutput.

Update phase in the native player loop.

Native engine system updated by the native player loop.

Update phase in the native player loop.

Native engine system updated by the native player loop.

Update phase in the native player loop.

Native engine system updated by the native player loop.

Update phase in the native player loop.

Native engine system updated by the native player loop.

Update phase in the native player loop.

Native engine system updated by the native player loop.

Update phase in the native player loop.

Native engine system updated by the native player loop.

Update phase in the native player loop.

Native engine system updated by the native player loop.

Allows the asynchronous read back of GPU resources.

Triggers a request to asynchronously fetch the data from a GPU resource.

The resource to read the data from. Size in bytes of the data to be retrieved from the ComputeBuffer. Offset in bytes in the ComputeBuffer. The index of the mipmap to be fetched. The target TextureFormat of the data. Conversion will happen automatically if format is different from the format stored on GPU. Starting X coordinate in pixels of the Texture data to be fetched. Width in pixels of the Texture data to be fetched. Starting Y coordinate in pixels of the Texture data to be fetched. Height in pixels of the Texture data to be fetched. Start Z coordinate in pixels for the Texture3D being fetched. Index of Start layer for TextureCube, Texture2DArray and TextureCubeArray being fetched. Depth in pixels for Texture3D being fetched. Number of layers for TextureCube, TextureArray and TextureCubeArray. An AsyncGPUReadbackRequest that can be used to both access the data and check whether it is available.

Triggers a request to asynchronously fetch the data from a GPU resource.

Represents an asynchronous request for a GPU resource.

Checks whether the request has been processed.

This property is true if the request has encountered an error.

Number of layers in the current request.

Fetches the data of a successful request.

The index of the layer to retrieve.

Triggers an update of the request.

Waits for completion of the request.

Values for the blend state.

Turns on alpha-to-coverage.

Blend state for render target 0.

Blend state for render target 1.

Blend state for render target 2.

Blend state for render target 3.

Blend state for render target 4.

Blend state for render target 5.

Blend state for render target 6.

Blend state for render target 7.

Determines whether each render target uses a separate blend state.

Creates a new blend state with the specified values.

Determines whether each render target uses a separate blend state. Turns on alpha-to-coverage.

Default values for the blend state.

Camera related properties in CullingParameters.

Get a camera culling plane.

Plane index (up to 5). Camera culling plane.

Get a shadow culling plane.

Plane index (up to 5). Shadow culling plane.

Set a camera culling plane.

Plane index (up to 5). Camera culling plane.

Set a shadow culling plane.

Plane index (up to 5). Shadow culling plane.

Core Camera related properties in CullingParameters.

Culling results (visible objects, lights, reflection probes).

Array of visible lights.

Off screen lights that still effect visible scene vertices.

Array of visible reflection probes.

Visible renderers.

Calculates the view and projection matrices and shadow split data for a directional light.

The index into the active light array. The cascade index. The number of cascades. The cascade ratios. The resolution of the shadowmap. The near plane offset for the light. The computed view matrix. The computed projection matrix. The computed cascade data. If false, the shadow map for this cascade does not need to be rendered this frame.

Calculates the view and projection matrices and shadow split data for a point light.

The index into the active light array. The cubemap face to be rendered. The amount by which to increase the camera FOV above 90 degrees. The computed view matrix. The computed projection matrix. The computed split data. If false, the shadow map for this light and cubemap face does not need to be rendered this frame.

Calculates the view and projection matrices and shadow split data for a spot light.

The index into the active light array. The computed view matrix. The computed projection matrix. The computed split data. If false, the shadow map for this light does not need to be rendered this frame.

Perform culling for a Camera.

Camera to cull for. Render loop the culling results will be used with. Culling results. Flag indicating whether culling succeeded.

Perform culling with custom CullingParameters.

Parameters for culling. Render loop the culling results will be used with. Culling results.

Fills a compute buffer with per-object light indices.

The compute buffer object to fill.

Get culling parameters for a camera.

Camera to get parameters for. Resultant culling parameters. Generate single-pass stereo aware culling parameters. Flag indicating whether culling parameters are valid.

Get culling parameters for a camera.

Camera to get parameters for. Resultant culling parameters. Generate single-pass stereo aware culling parameters. Flag indicating whether culling parameters are valid.

If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists.

Array of indices that map from VisibleLight indices to internal per-object light list indices.

Gets the number of per-object light indices.

The number of per-object light indices.

Returns the bounding box that encapsulates the visible shadow casters. Can be used to, for instance, dynamically adjust cascade ranges.

The index of the shadow-casting light. The bounds to be computed. True if the light affects at least one shadow casting object in the scene.

If a RenderPipeline sorts or otherwise modifies the VisibleLight list, an index remap will be necessary to properly make use of per-object light lists. If an element of the array is set to -1, the light corresponding to that element will be disabled.

Array with light indices that map from VisibleLight to internal per-object light lists.

Values for the depth state.

How should depth testing be performed.

Controls whether pixels from this object are written to the depth buffer.

Creates a new depth state with the given values.

Controls whether pixels from this object are written to the depth buffer. How should depth testing be performed.

Default values for the depth state.

Flags controlling RenderLoop.DrawRenderers.

When set, enables dynamic batching.

When set, enables GPU instancing.

No flags are set.

Settings for ScriptableRenderContext.DrawRenderers.

Other flags controlling object rendering.

The maxiumum number of passes that can be rendered in 1 DrawRenderers call.

What kind of per-object data to setup during rendering.

How to sort objects during rendering.

Create a draw settings struct.

Camera to use. Camera's transparency sort mode is used to determine whether to use orthographic or distance based sorting. Shader pass to use.

Set the Material to use for all drawers that would render in this group.

Override material. Pass to use in the material.

Set the shader passes that this draw call can render.

Index of the shader pass to use. Name of the shader pass.

Describes how to sort objects during rendering.

Camera position, used to determine distances to objects.

What kind of sorting to do while rendering.

Should orthographic sorting be used?

Camera view matrix, used to determine distances to objects.

Settings for RenderLoop.DrawShadows.

Culling results to use.

The index of the shadow-casting light to be rendered.

The split data.

Create a shadow settings object.

The cull results for this light. The light index.

Filter settings for ScriptableRenderContext.DrawRenderers.

Only render objects in the given layer mask.

The rendering layer mask to use when filtering available renderers for drawing.

Render objects whose material render queue in inside this range.

Specifies whether the values of the struct should be initialized.

Describes a subset of objects to be rendered. See Also: ScriptableRenderContext.DrawRenderers.

Defines a series of commands and settings that describes how Unity renders a frame.

When the IRenderPipeline is invalid or destroyed this returns true.

Defines custom rendering for this RenderPipeline.

Structure that holds the rendering commands for this loop. Cameras to render.

An asset that produces a specific IRenderPipeline.

Create a IRenderPipeline specific to this asset.

Created pipeline.

Override this method to destroy RenderPipeline cached state.

LODGroup culling parameters.

Rendering view height in pixels.

Camera position.

Camera's field of view.

Indicates whether camera is orthographic.

Orhographic camera size.

Values for the raster state.

Controls which sides of polygons should be culled (not drawn).

Enable clipping based on depth.

Scales the maximum Z slope.

Scales the minimum resolvable depth buffer value.

Creates a new raster state with the given values.

Controls which sides of polygons should be culled (not drawn). Scales the minimum resolvable depth buffer value. Scales the maximum Z slope.

Default values for the raster state.

Visible reflection probes sorting options.

Sort probes by importance.

Sort probes by importance, then by size.

Do not sort reflection probes.

Sort probes from largest to smallest.

What kind of per-object data to setup during rendering.

Do not setup any particular per-object data besides the transformation matrix.

Setup per-object lightmaps.

Setup per-object light probe SH data.

Setup per-object light probe proxy volume data.

Setup per-object motion vectors.

Setup per-object occlusion probe data.

Setup per-object occlusion probe proxy volume data (occlusion in alpha channels).

Setup per-object reflection probe data.

Setup per-object shadowmask.

Setup per-object light indices.

Object encapsulating the duration of a single renderpass that contains one or more subpasses. The RenderPass object provides a new way to switch rendertargets in the context of a Scriptable Rendering Pipeline. As opposed to the SetRenderTargets function, the RenderPass object specifies a clear beginning and an end for the rendering, alongside explicit load/store actions on the rendering surfaces. The RenderPass object also allows running multiple subpasses within the same renderpass, where the pixel shaders have a read access to the current pixel value within the renderpass. This allows for efficient implementation of various rendering methods on tile-based GPUs, such as deferred rendering. RenderPasses are natively implemented on Metal (iOS) and Vulkan, but the API is fully functional on all rendering backends via emulation (using legacy SetRenderTargets calls and reading the current pixel values via texel fetches). A quick example on how to use the RenderPass API within the Scriptable Render Pipeline to implement deferred rendering: The RenderPass mechanism has the following limitations: - All attachments must have the same resolution and MSAA sample count - The rendering results of previous subpasses are only available within the same screen-space pixel coordinate via the UNITY_READ_FRAMEBUFFER_INPUT(x) macro in the shader; the attachments cannot be bound as textures or otherwise accessed until the renderpass has ended - iOS Metal does not allow reading from the Z-Buffer, so an additional render target is needed to work around that - The maximum amount of attachments allowed per RenderPass is currently 8 + depth, but note that various GPUs may have stricter limits.

Read only: array of RenderPassAttachment objects currently bound into this RenderPass.

Read only: The ScriptableRenderContext object this RenderPass was created for.

Read only: The depth/stencil attachment used in this RenderPass, or null if none.

Read only: The height of the RenderPass surfaces in pixels.

Read only: MSAA sample count for this RenderPass.

Read only: The width of the RenderPass surfaces in pixels.

Create a RenderPass and start it within the ScriptableRenderContext.

The ScriptableRenderContext object currently being rendered. The width of the RenderPass surfaces in pixels. The height of the RenderPass surfaces in pixels. MSAA sample count; set to 1 to disable antialiasing. Array of color attachments to use within this RenderPass. The attachment to be used as the depthstencil buffer for this RenderPass, or null to disable depthstencil.

End the RenderPass.

This class encapsulates a single subpass within a RenderPass. RenderPasses can never be standalone, they must always contain at least one SubPass. See Also: RenderPass.

Create a subpass and start it.

The RenderPass object this subpass is part of. Array of attachments to be used as the color render targets in this subpass. All attachments in this array must also be declared in the RenderPass constructor. Array of attachments to be used as input attachments in this subpass. All attachments in this array must also be declared in the RenderPass constructor. If true, the depth attachment is read-only in this subpass. Some renderers require this in order to be able to use the depth attachment as input.

End the subpass.

A declaration of a single color or depth rendering surface to be attached into a RenderPass.

The currently assigned clear color for this attachment. Default is black.

Currently assigned depth clear value for this attachment. Default value is 1.0.

Currently assigned stencil clear value for this attachment. Default is 0.

The RenderTextureFormat of this attachment.

The load action to be used on this attachment when the RenderPass starts.

The store action to use with this attachment when the RenderPass ends. Only used when either BindSurface or BindResolveSurface has been called.

When the renderpass that uses this attachment ends, resolve the MSAA surface into the given target.

The target surface to receive the MSAA-resolved pixels.

Binds this RenderPassAttachment to the given target surface.

The surface to use as the backing storage for this RenderPassAttachment. Whether to read in the existing contents of the surface when the RenderPass starts. Whether to store the rendering results of the attachment when the RenderPass ends.

When the RenderPass starts, clear this attachment into the color or depth/stencil values given (depending on the format of this attachment). Changes loadAction to RenderBufferLoadAction.Clear.

Color clear value. Ignored on depth/stencil attachments. Depth clear value. Ignored on color surfaces. Stencil clear value. Ignored on color or depth-only surfaces.

Create a RenderPassAttachment to be used with RenderPass.

The format of this attachment.

Defines a series of commands and settings that describes how Unity renders a frame.

Call that should be issued by an SRP when the SRP begins to render a Camera so that other systems can inject per camera render logic.

Call that should be issued by an SRP when the SRP begins to render so that other systems can inject 'pre render' logic.

When the IRenderPipeline is invalid or destroyed this returns true.

Call the delegate used during SRP rendering before a single camera starts rendering.

Call the delegate used during SRP rendering before a render begins.

Dispose the Renderpipeline destroying all internal state.

Defines custom rendering for this RenderPipeline.

An asset that produces a specific IRenderPipeline.

Returns the list of current IRenderPipeline's created by the asset.

Enumerable of created pipelines.

Create a IRenderPipeline specific to this asset.

Created pipeline.

Destroys all cached data and created IRenderLoop's.

Return the default 2D Material for this pipeline.

Default material.

Return the default Line Material for this pipeline.

Default material.

Return the default Material for this pipeline.

Default material.

Return the default particle Material for this pipeline.

Default material.

Return the default Shader for this pipeline.

Default shader.

Return the default Terrain Material for this pipeline.

Default material.

Return the default UI ETC1 Material for this pipeline.

Default material.

Return the default UI Material for this pipeline.

Default material.

Return the default UI overdraw Material for this pipeline.

Default material.

Create a IRenderPipeline specific to this asset.

Created pipeline.

Default implementation of OnDisable for RenderPipelineAsset. See ScriptableObject.OnDisable

Default implementation of OnValidate for RenderPipelineAsset. See MonoBehaviour.OnValidate

Render Pipeline manager.

Returns the instance of the currently used Render Pipeline.

Describes a material render queue range.

A range that includes all objects.

Inclusive upper bound for the range.

Inclusive lower bound for the range.

A range that includes only opaque objects.

A range that includes only transparent objects.

A set of values used to override the render state. Note that it is not enough to set e.g. blendState, but that mask must also include RenderStateMask.Blend for the override to occur.

Specifies the new blend state.

Specifies the new depth state.

Specifies which parts of the render state that is overriden.

Specifies the new raster state.

The value to be compared against and/or the value to be written to the buffer based on the stencil state.

Specifies the new stencil state.

Creates a new render state block with the specified mask.

Specifies which parts of the render state that is overriden.

Maps a RenderType to a specific render state override.

Specifices the RenderType to override the render state for.

Specifies the values to override the render state with.

Creates a new render state mapping with the specified values.

Specifices the RenderType to override the render state for. Specifies the values to override the render state with.

Creates a new render state mapping with the specified values.

Specifices the RenderType to override the render state for. Specifies the values to override the render state with.

Specifies which parts of the render state that is overriden.

When set, the blend state is overridden.

When set, the depth state is overridden.

When set, all render states are overridden.

No render states are overridden.

When set, the raster state is overridden.

When set, the stencil state and reference value is overridden.

Values for the blend state.

Operation used for blending the alpha (A) channel.

Operation used for blending the color (RGB) channel.

Blend factor used for the alpha (A) channel of the destination.

Blend factor used for the color (RGB) channel of the destination.

Blend factor used for the alpha (A) channel of the source.

Blend factor used for the color (RGB) channel of the source.

Specifies which color components will get written into the target framebuffer.

Creates a new blend state with the given values.

Specifies which color components will get written into the target framebuffer. Blend factor used for the color (RGB) channel of the source. Blend factor used for the color (RGB) channel of the destination. Blend factor used for the alpha (A) channel of the source. Blend factor used for the alpha (A) channel of the destination. Operation used for blending the color (RGB) channel. Operation used for blending the alpha (A) channel.

Default values for the blend state.

Parameters controlling culling process in CullResults.

Camera Properties used for culling.

Culling Flags for the culling.

CullingMask used for culling.

CullingMatrix used for culling.

Number of culling planes to use.

The projection matrix generated for single-pass stereo culling.

Distance between the virtual eyes.

The view matrix generated for single-pass stereo culling.

Is the cull orthographic.

Layers to cull.

LODParameters for culling.

Position for the origin of th cull.

Reflection Probe Sort options for the cull.

Scene Mask to use for the cull.

Shadow distance to use for the cull.

Fetch the culling plane at the given index.

Get the distance for the culling of a specific layer.

Set the culling plane at a given index.

Set the distance for the culling of a specific layer.

Defines state and drawing commands used in a custom render pipelines.

Draw subset of visible objects.

Specifies parts of the render state to override. Specifies parts of the render state to override for specific render types. Specifies which set of visible objects to draw. Specifies how to draw the objects. Specifies how the renderers should be further filtered.

Draw subset of visible objects.

Draw shadow casters for a single light.

Specifies which set of shadow casters to draw, and how to draw them.

Draw skybox.

Camera to draw the skybox for.

Execute a custom graphics command buffer.

Command buffer to execute.

Executes a command buffer on an async compute queue with the queue selected based on the ComputeQueueType parameter passed. It is required that all of the commands within the command buffer be of a type suitable for execution on the async compute queues. If the buffer contains any commands that are not appropriate then an error will be logged and displayed in the editor window. Specifically the following commands are permitted in a CommandBuffer intended for async execution: CommandBuffer.BeginSample CommandBuffer.CopyCounterValue CommandBuffer.CopyTexture CommandBuffer.CreateGPUFence CommandBuffer.DispatchCompute CommandBuffer.EndSample CommandBuffer.IssuePluginEvent CommandBuffer.SetComputeBufferParam CommandBuffer.SetComputeFloatParam CommandBuffer.SetComputeFloatParams CommandBuffer.SetComputeTextureParam CommandBuffer.SetComputeVectorParam CommandBuffer.WaitOnGPUFence All of the commands within the buffer are guaranteed to be executed on the same queue. If the target platform does not support async compute queues then the work is dispatched on the graphics queue.

The CommandBuffer to be executed. Describes the desired async compute queue the supplied CommandBuffer should be executed on.

Setup camera specific global shader variables.

Camera to setup shader variables for. Set up the stereo shader variables and state.

Setup camera specific global shader variables.

Camera to setup shader variables for. Set up the stereo shader variables and state.

Fine-grain control to begin stereo rendering on the scriptable render context.

Camera to enable stereo rendering on.

Indicate completion of stereo rendering on a single frame.

Camera to indicate completion of stereo rendering.

Stop stereo rendering on the scriptable render context.

Camera to disable stereo rendering on.

Submit rendering loop for execution.

Shader pass name identifier.

Create shader pass name identifier.

Pass name.

Describes the culling information for a given shadow split (e.g. directional cascade).

The number of culling planes.

The culling sphere. The first three components of the vector describe the sphere center, and the last component specifies the radius.

Gets a culling plane.

The culling plane index. The culling plane.

Sets a culling plane.

The index of the culling plane to set. The culling plane.

How to sort objects during rendering.

Sort objects back to front.

Sort renderers taking canvas order into account.

Typical sorting for opaque objects.

Typical sorting for transparencies.

Do not sort objects.

Sort objects to reduce draw state changes.

Sort objects in rough front-to-back buckets.

Sort by material render queue.

Sort by renderer sorting layer.

Values for the stencil state.

The function used to compare the reference value to the current contents of the buffer.

The function used to compare the reference value to the current contents of the buffer for back-facing geometry.

The function used to compare the reference value to the current contents of the buffer for front-facing geometry.

Controls whether the stencil buffer is enabled.

What to do with the contents of the buffer if the stencil test fails.

What to do with the contents of the buffer if the stencil test fails for back-facing geometry.

What to do with the contents of the buffer if the stencil test fails for front-facing geometry.

What to do with the contents of the buffer if the stencil test (and the depth test) passes.

What to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry.

What to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry.

An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer.

An 8 bit mask as an 0–255 integer, used when writing to the buffer.

What to do with the contents of the buffer if the stencil test passes, but the depth test fails.

What to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry.

What to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry.

Creates a new stencil state with the given values.

An 8 bit mask as an 0–255 integer, used when comparing the reference value with the contents of the buffer. An 8 bit mask as an 0–255 integer, used when writing to the buffer. Controls whether the stencil buffer is enabled. The function used to compare the reference value to the current contents of the buffer for front-facing geometry. What to do with the contents of the buffer if the stencil test (and the depth test) passes for front-facing geometry. What to do with the contents of the buffer if the stencil test fails for front-facing geometry. What to do with the contents of the buffer if the stencil test passes, but the depth test fails for front-facing geometry. The function used to compare the reference value to the current contents of the buffer for back-facing geometry. What to do with the contents of the buffer if the stencil test (and the depth test) passes for back-facing geometry. What to do with the contents of the buffer if the stencil test fails for back-facing geometry. What to do with the contents of the buffer if the stencil test passes, but the depth test fails for back-facing geometry. The function used to compare the reference value to the current contents of the buffer. What to do with the contents of the buffer if the stencil test (and the depth test) passes. What to do with the contents of the buffer if the stencil test fails. What to do with the contents of the buffer if the stencil test passes, but the depth test.

Creates a new stencil state with the given values.

Default values for the stencil state.

Describes the rendering features supported by a given render pipeline.

Get / Set a SupportedRenderingFeatures.

This is the fallback mode if the mode the user had previously selected is no longer available. See SupportedRenderingFeatures.supportedMixedLightingModes.

Flags for supported reflection probes.

Are light probe proxy volumes supported?

Are motion vectors supported?

Can renderers support receiving shadows?

Are reflection probes supported?

What baking types are supported. The unsupported ones will be hidden from the UI. See LightmapBakeType.

Specifies what modes are supported. Has to be at least one. See LightmapsMode.

Specifies what LightmapMixedBakeMode that are supported. Please define a SupportedRenderingFeatures.defaultMixedLightingMode in case multiple modes are supported.

Same as MixedLightingMode for baking, but is used to determine what is supported by the pipeline.

Same as MixedLightingMode.IndirectOnly but determines if it is supported by the pipeline.

No mode is supported.

Same as MixedLightingMode.Shadowmask but determines if it is supported by the pipeline.

Same as MixedLightingMode.Subtractive but determines if it is supported by the pipeline.

Supported modes for ReflectionProbes.

Default reflection probe support.

Rotated reflection probes are supported.

A list of data channels that describe a vertex in a mesh.

The color channel.

The normal channel. The common format is Vector3.

The position channel. The common format is Vector3.

The tangent channel. The common format is Vector4.

The primary UV channel. The common format is Vector2.

Additional UV channel. The common format is Vector2.

Holds data of a visible light.

Light color multiplied by intensity.

Light flags, see VisibleLightFlags.

Accessor to Light component.

Light type.

Light transformation matrix.

Light range.

Light's influence rectangle on screen.

Spot light angle.

Flags for VisibleLight.

Light intersects far clipping plane.

Light intersects near clipping plane.

No flags are set.

Holds data of a visible reflection probe.

Probe blending distance.

Probe bounding box.

Should probe use box projection.

Probe projection center.

Shader data for probe HDR texture decoding.

Probe importance.

Probe transformation matrix.

Accessor to ReflectionProbe component.

Probe texture.

Experimental render settings features.

If enabled, ambient trilight will be sampled using the old radiance sampling method.

A struct that holds a rich set of information that describes the bind pose of this Sprite.

The length of the bone. This is important for the leaf bones to describe their length without needing another bone as the terminal bone.

The name of the bone. This is useful when recreating bone hierarchy at editor or runtime. You can also use this as a way of resolving the bone path when a Sprite is bound to a more complex or richer hierarchy.

The ID of the parent of this bone.

The position in local space of this bone.

The rotation of this bone in local space.

A list of methods designed for reading and writing to the rich internal data of a Sprite.

Returns an array of BindPoses.

The sprite to retrieve the bind pose from. A list of bind poses for this sprite. There is no need to dispose the returned NativeArray.

Returns a list of SpriteBone in this Sprite.

The sprite to get the list of SpriteBone from. An array of SpriteBone that belongs to this Sprite.

Returns a list of BoneWeight that corresponds to each and every vertice in this Sprite.

The Sprite to get the BoneWeights from. The list of BoneWeight. The length should equal the number of vertices. There is no need to call dispose on this NativeArray.

Returns a list of indices. This is the same as Sprite.triangle.

A read-only list of indices indicating how the triangles are formed between the vertices. The array is marked as undisposable.

Retrieves a strided accessor to the internal vertex attributes.

A read-only list of.

Returns the number of vertices in this Sprite.

Checks if a specific channel exists for this Sprite.

True if the channel exists.

Sets the bind poses for this Sprite.

The list of bind poses for this Sprite. The array must be disposed of by the caller.

Sets the SpriteBones for this Sprite.

Sets the BoneWeight for this Sprite. The length of the input array must match the number of vertices.

The list of BoneWeight for this Sprite. The array must be disposed of by the caller.

Set the indices for this Sprite. This is the same as Sprite.triangle.

The list of indices for this Sprite. The array must be disposed of by the caller.

Sets a specific channel of the VertexAttribute.

The list of values for this specific VertexAttribute channel. The array must be disposed of by the caller.

Sets the vertex count. This resizes the internal buffer. It also preserves any configurations of VertexAttributes.

A list of methods that allow the caller to override what the SpriteRenderer renders.

Stop using the deformable buffer to render the Sprite and use the original mesh instead.

Returns an array of vertices to be deformed by the caller.

Provides the JobHandle that updates the deform buffer to the SpriteRenderer.

Object that is used to resolve references to an ExposedReference field.

Creates a type whos value is resolvable at runtime.

The default value, in case the value cannot be resolved.

The name of the ExposedReference.

Gets the value of the reference by resolving it given the ExposedPropertyResolver context object.

The ExposedPropertyResolver context object. The resolved reference value.

Filtering mode for textures. Corresponds to the settings in a.

Bilinear filtering - texture samples are averaged.

Point filtering - texture pixels become blocky up close.

Trilinear filtering - texture samples are averaged and also blended between mipmap levels.

A flare asset. Read more about flares in the.

FlareLayer component.

Fog mode to use.

Exponential fog.

Exponential squared fog (default).

Linear fog.

Struct containing basic FrameTimings and accompanying relevant data.

The CPU time for a given frame, in ms.

This is the CPU clock time at the point GPU finished rendering the frame and interrupted the CPU.

This is the CPU clock time at the point Present was called for the current frame.

The GPU time for a given frame, in ms.

This was the height scale factor of the Dynamic Resolution system(if used) for the given frame and the linked frame timings.

This was the vsync mode for the given frame and the linked frame timings.

This was the width scale factor of the Dynamic Resolution system(if used) for the given frame and the linked frame timings.

The FrameTimingManager allows the user to capture and access FrameTiming data for multple frames.

This function triggers the FrameTimingManager to capture a snapshot of FrameTiming's data, that can then be accessed by the user.

This returns the frequency of CPU timer on the current platform, used to interpret timing results. If the platform does not support returning this value it will return 0.

CPU timer frequency for current platform.

This returns the frequency of GPU timer on the current platform, used to interpret timing results. If the platform does not support returning this value it will return 0.

GPU timer frequency for current platform.

Allows the user to access the currently captured FrameTimings.

User supplies a desired number of frames they would like FrameTimings for. This should be equal to or less than the maximum FrameTimings the platform can capture. An array of FrameTiming structs that is passed in by the user and will be filled with data as requested. It is the users job to make sure the array that is passed is large enough to hold the requested number of FrameTimings. Returns the number of FrameTimings it actually was able to get. This will always be equal to or less than the requested numFrames depending on availability of captured FrameTimings.

This returns the number of vsyncs per second on the current platform, used to interpret timing results. If the platform does not support returning this value it will return 0.

Number of vsyncs per second of the current platform.

This struct contains the view space coordinates of the near projection plane.

Position in view space of the bottom side of the near projection plane.

Position in view space of the left side of the near projection plane.

Position in view space of the right side of the near projection plane.

Position in view space of the top side of the near projection plane.

Z distance from the origin of view space to the far projection plane.

Z distance from the origin of view space to the near projection plane.

Platform agnostic fullscreen mode. Not all platforms support all modes.

Exclusive Mode.

Fullscreen window.

Maximized window.

Windowed.

Base class for all entities in Unity scenes.

Defines whether the GameObject is active in the Scene.

The local active state of this GameObject. (Read Only)

Editor only API that specifies if a game object is static.

The layer the game object is in. A layer is in the range [0...31].

Scene that the GameObject is part of.

The tag of this game object.

The Transform attached to this GameObject.

Adds a component class named className to the game object.

Adds a component class of type componentType to the game object. C# Users can use a generic version.

Generic version. See the page for more details.

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

Is this game object tagged with tag ?

The tag to compare.

Creates a game object with a primitive mesh renderer and appropriate collider.

The type of primitive object to create.

Creates a new game object, named name.

The name that the GameObject is created with. A list of Components to add to the GameObject on creation.

Creates a new game object, named name.

The name that the GameObject is created with. A list of Components to add to the GameObject on creation.

Creates a new game object, named name.

The name that the GameObject is created with. A list of Components to add to the GameObject on creation.

Finds a GameObject by name and returns it.

Returns a list of active GameObjects tagged tag. Returns empty array if no GameObject was found.

The name of the tag to search GameObjects for.

Returns one active GameObject tagged tag. Returns null if no GameObject was found.

The tag to search for.

Returns the component of Type type if the game object has one attached, null if it doesn't.

The type of Component to retrieve.

Generic version. See the page for more details.

Returns the component with name type if the game object has one attached, null if it doesn't.

The type of Component to retrieve.

Returns the component of Type type in the GameObject or any of its children using depth first search.

The type of Component to retrieve. A component of the matching type, if found.

Returns the component of Type type in the GameObject or any of its children using depth first search.

The type of Component to retrieve. A component of the matching type, if found.

Generic version. See the page for more details.

A component of the matching type, if found.

Generic version. See the page for more details.

A component of the matching type, if found.

Returns the component of Type type in the GameObject or any of its parents.

Type of component to find.

Returns the component <T> in the GameObject or any of its parents.

Returns all components of Type type in the GameObject.

The type of Component to retrieve.

Generic version. See the page for more details.

Returns all components of Type type in the GameObject into List results. Note that results is of type Component, not the type of the component retrieved.

The type of Component to retrieve. List to receive the results.

Returns all components of Type type in the GameObject into List results.

List of type T to receive the results.

Returns all components of Type type in the GameObject or any of its children.

The type of Component to retrieve. Should Components on inactive GameObjects be included in the found set?

Returns all components of Type type in the GameObject or any of its children.

The type of Component to retrieve. Should Components on inactive GameObjects be included in the found set?

Generic version. See the page for more details.

Should inactive GameObjects be included in the found set? A list of all found components matching the specified type.

Generic version. See the page for more details.

Should inactive GameObjects be included in the found set? A list of all found components matching the specified type.

Return all found Components into List results.

List to receive found Components. Should inactive GameObjects be included in the found set?

Return all found Components into List results.

List to receive found Components. Should inactive GameObjects be included in the found set?

Returns all components of Type type in the GameObject or any of its parents.

The type of Component to retrieve. Should inactive Components be included in the found set?

Generic version. See the page for more details.

Should inactive Components be included in the found set?

Generic version. See the page for more details.

Should inactive Components be included in the found set?

Find Components in GameObject or parents, and return them in List results.

Should inactive Components be included in the found set? List holding the found Components.

Calls the method named methodName on every MonoBehaviour in this game object.

The name of the method to call. An optional parameter value to pass to the called method. Should an error be raised if the method doesn't exist on the target object?