Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetPreloading(float, bool, Camera)

Initiate preloading of streaming data for this camera.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.StreamingModule
public void SetPreloading(float timeoutSeconds = 0, bool activateCameraOnTimeout = false, Camera disableCameraCuttingFrom = null)

Parameters

timeoutSeconds

float
Optional timeout before stopping preloading. Set to 0.0f when no timeout is required.

activateCameraOnTimeout

bool
Set to True to activate the connected Camera component when timeout expires.

disableCameraCuttingFrom

Camera
Camera to deactivate on timeout (if activateCameraOnTime is True). This parameter can be null.

Remarks

Activate texture streaming at this camera location. This is for preloading texture mipmaps prior to a Camera being activated a short time later. When the Camera component on the same GameObject becomes enabled, preloading will be disabled. Preloading can be manually disabled with StreamingController.CancelPreloading
The function will do nothing if called when the associated Camera is already enabled.