Version: 2022.3
LanguageEnglish
  • C#

WebCamTexture

class in UnityEngine

/

Inherits from:Texture

/

Implemented in:UnityEngine.AudioModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

WebCam Textures are textures onto which the live video input is rendered.

Static Properties

devicesReturn a list of available devices.

Properties

autoFocusPointThis property allows you to set/get the auto focus point of the camera. This works only on Android and iOS devices.
deviceNameSet this to specify the name of the device to use.
didUpdateThisFrameDid the video buffer update this frame?
isDepthThis property is true if the texture is based on depth data.
isPlayingReturns if the camera is currently playing.
requestedFPSSet the requested frame rate of the camera device (in frames per second).
requestedHeightSet the requested height of the camera device.
requestedWidthSet the requested width of the camera device.
videoRotationAngleReturns an clockwise angle (in degrees), which can be used to rotate a polygon so camera contents are shown in correct orientation.
videoVerticallyMirroredReturns if the texture image is vertically flipped.

Constructors

WebCamTextureCreate a WebCamTexture.

Public Methods

GetPixelGets the pixel color at coordinates (x, y).
GetPixelsGets the pixel color data for a mipmap level as Color structs.
GetPixels32Gets the pixel color data for a mipmap level as Color32 structs.
PausePauses the camera.
PlayStarts the camera.
StopStops the camera.

Inherited Members

Static Properties

allowThreadedTextureCreationAllow Unity internals to perform Texture creation on any thread (rather than the dedicated render thread).
currentTextureMemoryThe amount of memory that all Textures in the scene use.
desiredTextureMemoryThe total size of the Textures, in bytes, that Unity loads if there were no other constraints. Before Unity loads any Textures, it applies the memory budget which reduces the loaded Texture resolution if the Texture sizes exceed its value. The desiredTextureMemory value takes into account the mipmap levels that Unity has requested or that you have set manually.For example, if Unity does not load a Texture at full resolution because it is far away or its requested mipmap level is greater than 0, Unity reduces the desiredTextureMemory value to match the total memory needed.The desiredTextureMemory value can be greater than the Texture.targetTextureMemory value.
GenerateAllMipsCan be used with Texture constructors that take a mip count to indicate that all mips should be generated. The value of this field is -1.
nonStreamingTextureCountThe number of non-streaming Textures in the scene. This includes instances of Texture2D and CubeMap Textures. This does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally.
nonStreamingTextureMemoryThe amount of memory Unity allocates for non-streaming Textures in the scene. This only includes instances of Texture2D and CubeMap Textures. This does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally.
streamingMipmapUploadCountHow many times has a Texture been uploaded due to Texture mipmap streaming.
streamingRendererCountNumber of renderers registered with the Texture streaming system.
streamingTextureCountNumber of streaming Textures.
streamingTextureDiscardUnusedMipsThis property forces the streaming Texture system to discard all unused mipmaps instead of caching them until the Texture memory budget is exceeded. This is useful when you profile or write tests to keep a predictable set of Textures in memory.
streamingTextureForceLoadAllForce streaming Textures to load all mipmap levels.
streamingTextureLoadingCountNumber of streaming Textures with mipmaps currently loading.
streamingTexturePendingLoadCountNumber of streaming Textures with outstanding mipmaps to be loaded.
targetTextureMemoryThe total amount of Texture memory that Unity allocates to the Textures in the scene after it applies the memory budget and finishes loading Textures. `targetTextureMemory`also takes mipmap streaming settings into account. This value only includes instances of Texture2D and CubeMap Textures. This value does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally.
totalTextureMemoryThe total amount of Texture memory that Unity would use if it loads all Textures at mipmap level 0. This is a theoretical value that does not take into account any input from the streaming system or any other input, for example when you set the`Texture2D.requestedMipmapLevel` manually. To see a Texture memory value that takes inputs into account, use `desiredTextureMemory`. `totalTextureMemory` only includes instances of Texture2D and CubeMap Textures. This value does not include any other Texture types, or 2D and CubeMap Textures that Unity creates internally.

Properties

hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.
anisoLevelDefines the anisotropic filtering level of the Texture.
dimensionDimensionality (type) of the Texture (Read Only).
filterModeFiltering mode of the Texture.
graphicsFormatReturns the GraphicsFormat format or color format of a Texture object.
heightHeight of the Texture in pixels (Read Only).
imageContentsHashThe hash value of the Texture.
isDataSRGBReturns true if the texture pixel data is in sRGB color space (Read Only).
isReadableWhether Unity stores an additional copy of this texture's pixel data in CPU-addressable memory.
mipMapBiasThe mipmap bias of the Texture.
mipmapCountHow many mipmap levels are in this Texture (Read Only).
updateCountThis counter is incremented when the Texture is updated.
widthWidth of the Texture in pixels (Read Only).
wrapModeTexture coordinate wrapping mode.
wrapModeUTexture U coordinate wrapping mode.
wrapModeVTexture V coordinate wrapping mode.
wrapModeWTexture W coordinate wrapping mode for Texture3D.

Public Methods

GetInstanceIDGets the instance ID of the object.
ToStringReturns the name of the object.
GetNativeTexturePtrRetrieve a native (underlying graphics API) pointer to the Texture resource.
IncrementUpdateCountIncrement the update counter.

Static Methods

DestroyRemoves a GameObject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindAnyObjectByTypeRetrieves any active loaded object of Type type.
FindFirstObjectByTypeRetrieves the first active loaded object of Type type.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsByTypeRetrieves a list of all loaded objects of Type type.
FindObjectsOfTypeGets a list of all loaded objects of Type type.
InstantiateClones the object original and returns the clone.
InstantiateAsyncCaptures a snapshot of the original object (that must be related to some GameObject) and returns the AsyncInstantiateOperation.
SetGlobalAnisotropicFilteringLimitsSets Anisotropic limits.
SetStreamingTextureMaterialDebugPropertiesThis function sets mipmap streaming debug properties on any materials that use this Texture through the mipmap streaming system.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.