Microsoft.MixedReality.GraphicsTools Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
| AccessibilityUtilities |
Utility class to help with operations involving accessibility support. |
| AutoAddInputModules |
Ensures that a input system module exists for legacy input system projects. |
| BaseMeshOutline |
Abstract component to encapsulate common functionality around outline components. |
| CameraEventRouter |
A helper class to provide hooks into the Unity camera exclusive Lifecycle events |
| CanvasElementBeveledRect |
Procedurally generates a 3D rounded rect mesh to be rendered within a UnityUI canvas. |
| CanvasElementMesh |
Allows a 3D mesh to be rendered within a UnityUI canvas. |
| CanvasElementRoundedRect |
Procedurally generates a 3D rounded rect mesh to be rendered within a UnityUI canvas. |
| CanvasMaterialAnimatorBase |
The base class for all CanvasMaterialAnimators generated via Assets > Graphics Tools > Generate Canvas Material Animator. This behavior will expose all material properties of a Graphic's material so they can animated by Unity's animation system. |
| CanvasMaterialAnimatorCanvasBackplate |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorCanvasBeveled |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorCanvasFrontplate |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorCanvasGlow |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorCanvasProgressBar |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorCanvasQuadGlow |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorCanvasRadialSpinner |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorGraphicsToolsStandard |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorGraphicsToolsStandardCanvas |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorGraphicsToolsTextMeshPro |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasMaterialAnimatorGraphicsToolsWireframe |
This class was auto generated via Assets > Graphics Tools > Generate Canvas Material Animator. Use Unity's animation system to animate fields on this class to drive material properties on CanvasRenderers. Version=0.1.0 |
| CanvasShadow |
Displays a simulated shadow onto a canvas using projected shadowing. |
| ClippingBox |
Component to animate and visualize a box that can be used with per pixel based clipping. |
| ClippingPlane |
Component to animate and visualize a plane that can be used with per pixel based clipping. |
| ClippingPrimitive |
An abstract primitive component to animate and visualize a clipping primitive that can be used to drive per pixel based clipping. |
| ClippingSphere |
Component to animate and visualize a sphere that can be used with per pixel based clipping. |
| ComponentExtensions |
Extensions methods for the Unity Component class. This also includes some component-related extensions for the GameObject class. |
| ExperimentalAttribute |
A PropertyAttribute for showing a warning box that the tagged implementation is experimental. |
| FlyCameraController |
A simple "fly" camera for moving the camera while playing with a mouse/keyboard or gamepad. |
| FrontPlatePulse |
Animates material properties for the Graphics Tools/Non-Canvas/Frontplate and Graphics Tools/Canvas/Frontplate shaders to play a pulse ring effect at a point in 3D space. |
| HoverLight |
Utility component to animate and visualize a light that can be used with the GraphicsTools/Standard and GraphicsTools/Standard Canvas shaders "_HoverLight" feature. |
| MaterialInstance |
The MaterialInstance behavior aides in tracking instance material lifetime and automatically destroys instanced materials for the user. This utility component can be used as a replacement to Renderer.material or Renderer.materials. When invoking Unity's Renderer.material(s), Unity automatically instantiates new materials. It is the caller's responsibility to destroy the materials when a material is no longer needed or the game object is destroyed. The MaterialInstance behavior helps avoid material leaks and keeps material allocation paths consistent during edit and run time. |
| MaterialRestorer |
Utility class to help restore materials which are assets (normally shared materials) to their original state when modified. |
| MeshOutline |
Component which can be used to render an outline around a mesh renderer. Enabling this component introduces an additional render pass of the object being outlined, but is designed to run performantly on mobile Mixed Reality devices and does not utilize any post processes. This behavior is designed to be used in conjunction with the Graphics Tools/Standard shader. Limitations of this effect include it not working well on objects which are not watertight (or required to be two sided) and depth sorting issues can occur on overlapping objects. |
| MeshOutlineHierarchy |
Component which can be used to render an outline around a hierarchy of mesh renderers using the MeshOutline component. |
| MeshSmoother |
Component which can be used to automatically generate smoothed normals on a mesh and pack those normals into a UV set. Smoothed normals can be used for a variety of effects including extruding disjoint meshes along a vertex normal. This behavior is designed to be used in conjunction with the Graphics Tools/Standard shader which assumes smoothed normals are packed into the 3rd UV set. |
| ProximityLight |
Utility component to animate and visualize a light that can be used with the GraphicsTools/Standard and GraphicsTools/Standard Canvas shaders "_ProximityLight" feature. |
| ProximityLight.LightSettings |
All settings that represent a proximity light. |
| RectMask2DFast |
Overrides the RectMask2D.PerformClipping method to add extra checks before doing exhaustive culling on each maskable target. |
| RoundedRectMask2D |
A 2D rounded rectangular mask that allows for clipping / masking of areas outside the mask. Constraints:
|
| ScaleMeshEffect |
On Unity UI components the UNITY_MATRIX_M (unity_ObjectToWorld) matrix is not the transformation matrix of the local transform the Graphic component lives on, but that of its parent Canvas. Many Graphics Tools/Standard shader effects require object scale to be known. To solve this issue the ScaleMeshEffect will store scaling information into UV channel attributes during UI mesh construction. Ideally we would store the scale in one attribute but UGUI only supports two scalers per attribute (even in the tangent attribute). |
| StandardShaderUtility |
Graphics Tools standard shader utility class with commonly used constants, types and convenience methods. |
| ThemeCollection |
A scriptable object which contains data and UI functionality to swap object references within a scene. |
| ThemeCollection.Theme | |
| ThemeCollectionEditor |
Custom inspector for the ThemeCollection scriptable object. In the same file for portability. |
Interfaces
| IMaterialInstanceOwner |
Optional interface to use with objects which need to take ownership of MaterialInstance(s). |
Enums
| ClippingPrimitive.Side |
Should clipping occur inside or outside of the clipping shape? |
| ProximityLight.LightSettings.Handedness | |