Version: 2023.1

SpriteRenderer

class in UnityEngine

/

继承自:Renderer

切换到手册

描述

为 2D 图形渲染精灵。

//This example outputs Sliders that control the red green and blue elements of a sprite's color
//Attach this to a GameObject and attach a SpriteRenderer component

using UnityEngine;

public class Example : MonoBehaviour { SpriteRenderer m_SpriteRenderer; //The Color to be assigned to the Renderer’s Material Color m_NewColor;

//These are the values that the Color Sliders return float m_Red, m_Blue, m_Green;

void Start() { //Fetch the SpriteRenderer from the GameObject m_SpriteRenderer = GetComponent<SpriteRenderer>(); //Set the GameObject's Color quickly to a set Color (blue) m_SpriteRenderer.color = Color.blue; }

void OnGUI() { //Use the Sliders to manipulate the RGB component of Color //Use the Label to identify the Slider GUI.Label(new Rect(0, 30, 50, 30), "Red: "); //Use the Slider to change amount of red in the Color m_Red = GUI.HorizontalSlider(new Rect(35, 25, 200, 30), m_Red, 0, 1);

//The Slider manipulates the amount of green in the GameObject GUI.Label(new Rect(0, 70, 50, 30), "Green: "); m_Green = GUI.HorizontalSlider(new Rect(35, 60, 200, 30), m_Green, 0, 1);

//This Slider decides the amount of blue in the GameObject GUI.Label(new Rect(0, 105, 50, 30), "Blue: "); m_Blue = GUI.HorizontalSlider(new Rect(35, 95, 200, 30), m_Blue, 0, 1);

//Set the Color to the values gained from the Sliders m_NewColor = new Color(m_Red, m_Green, m_Blue);

//Set the SpriteRenderer to the Color defined by the Sliders m_SpriteRenderer.color = m_NewColor; } }

变量

adaptiveModeThreshold精灵渲染器平铺的当前阈值。
color为精灵图形渲染颜色。
drawMode精灵渲染器的当前绘制模式。
flipX在 X 轴上翻转精灵。
flipY在 Y 轴上翻转精灵。
maskInteraction指定精灵如何与遮罩交互。
sizeProperty to set or get the size to render when the SpriteRenderer.drawMode is set to SpriteDrawMode.Sliced or SpriteDrawMode.Tiled.
sprite要渲染的精灵。
spriteSortPoint确定用于对 SpriteRenderer 进行排序的 Sprite 的位置。
tileMode精灵渲染器的当前平铺模式。

公共函数

RegisterSpriteChangeCallbackRegisters a callback to receive a notification when the SpriteRenderer's Sprite reference changes.
UnregisterSpriteChangeCallbackRemoves a callback (that receives a notification when the Sprite reference changes) that was previously registered to a SpriteRenderer.

继承的成员

变量

gameObject此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag此游戏对象的标签。
transform附加到此 GameObject 的 Transform。
hideFlags该对象应该隐藏、随场景一起保存还是由用户修改?
name对象的名称。
allowOcclusionWhenDynamic控制是否应对该渲染器执行动态遮挡剔除。
boundsThe bounding box of the renderer in world space.
enabled如果启用,则使渲染的 3D 对象可见。
forceRenderingOff允许关闭特定组件的渲染。
isPartOfStaticBatchIndicates whether the renderer is part of a static batch with other renderers.
isVisible该渲染器是否在任何摄像机中可见?(只读)
lightmapIndex应用到该渲染器的烘焙光照贴图的索引。
lightmapScaleOffset用于光照贴图的 UV 缩放和偏移。
lightProbeProxyVolumeOverride如果设置,则渲染器将使用附加到源 GameObject 的 **Light Probe Proxy Volume** 组件。
lightProbeUsage光照探针插值类型。
localBoundsThe bounding box of the renderer in local space.
localToWorldMatrix将点从本地空间转换到世界空间的矩阵(只读)。
material返回指定给渲染器的第一个实例化 Material。
materials返回该对象的所有实例化材质。
motionVectorGenerationMode指定运动矢量渲染的模式。
probeAnchor如果设置,渲染器将使用该变换的位置来查找光源或反射探针。
rayTracingMode描述如何更新该渲染器来进行射线追踪。
realtimeLightmapIndexThe index of the real-time lightmap applied to this renderer.
realtimeLightmapScaleOffsetThe UV scale & offset used for a real-time lightmap.
receiveShadows该对象是否接受阴影?
reflectionProbeUsage是否应为该渲染器使用反射探针?
rendererPriority此值按优先级对渲染器排序。首先渲染较小值,最后渲染较大值。
renderingLayerMask确定该渲染器所在的渲染层。
shadowCastingMode该对象是否投射阴影?
sharedMaterial该对象的共享材质。
sharedMaterials该对象的所有共享材质。
sortingLayerID渲染器排序图层的唯一 ID。
sortingLayerName渲染器排序图层的名称。
sortingOrder排序图层中的渲染器顺序。
staticShadowCasterIs this renderer a static shadow caster?
worldToLocalMatrix将点从世界空间转换到本地空间的矩阵(只读)。

公共函数

BroadcastMessage调用此游戏对象或其任何子项中的每个 MonoBehaviour 上名为 methodName 的方法。
CompareTagChecks the GameObject's tag against the defined tag.
GetComponentGets a reference to a component of type T on the same GameObject as the component specified.
GetComponentInChildrenGets a reference to a component of type T on the same GameObject as the component specified, or any child of the GameObject.
GetComponentInParentGets a reference to a component of type T on the same GameObject as the component specified, or any parent of the GameObject.
GetComponentsGets references to all components of type T on the same GameObject as the component specified.
GetComponentsInChildrenGets references to all components of type T on the same GameObject as the component specified, and any child of the GameObject.
GetComponentsInParentGets references to all components of type T on the same GameObject as the component specified, and any parent of the GameObject.
SendMessage调用此游戏对象中的每个 MonoBehaviour 上名为 methodName 的方法。
SendMessageUpwards调用此游戏对象中的每个 MonoBehaviour 上或此行为的每个父级上名为 methodName 的方法。
TryGetComponent获取指定类型的组件(如果存在)。
GetInstanceIDGets the instance ID of the object.
ToString返回对象的名称。
GetClosestReflectionProbes返回一个数组,其中包含带有权重的最近反射探针。权重显示探针对渲染器的影响程度,当反射探针之间发生混合时,也会用到该值。
GetMaterials返回该对象的所有实例化材质。
GetPropertyBlock获取每渲染器或每材质的属性块。
GetSharedMaterials返回该对象的所有共享材质。
HasPropertyBlock如果渲染器具有通过 SetPropertyBlock 附加的材质属性块,则返回 true。
ResetBoundsReset custom world space bounds.
ResetLocalBoundsReset custom local space bounds.
SetMaterialsAssigns the shared materials of this object using the list of materials provided.
SetPropertyBlock允许您设置或清除每渲染器或每材质参数重写。
SetSharedMaterialsAssigns the shared materials of this object using the list of materials provided.

静态函数

Destroy移除 GameObject、组件或资源。
DestroyImmediate立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad在加载新的 Scene 时,请勿销毁 Object。
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
Instantiate克隆 original 对象并返回克隆对象。

运算符

bool该对象是否存在?
operator !=比较两个对象是否引用不同的对象。
operator ==比较两个对象引用,判断它们是否引用同一个对象。

消息

OnBecameInvisible OnBecameInvisible is called when the object is no longer visible by any camera.
OnBecameVisible OnBecameVisible is called when the object became visible by any camera.