s&box docs
API ReferenceSandbox

ICameraModifierclass

Reshapes a camera's view each frame - scope zoom, vehicle roll, aim-down-sights. Implement on any component: when a camera composes its view it runs every modifier in `Sandbox.ICameraModifier.CameraOrder`, then hands the final view to `Sandbox.ICameraModifier.PostCameraSetup(Sandbox.CameraComponent,Sandbox.CameraView@)` so things can be placed against it.

object→ICameraModifier
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public abstract interface Sandbox.ICameraModifier

Methods2

Showing 2 methods

public virtual void ModifyCamera(Sandbox.CameraComponent camera, Sandbox.CameraView view)PUBLICVIRTUALPER-FRAME

Reshape the view. Runs once per camera per frame, in order, at the camera stage of the tick - after Update and bone merging, before PreRender.

ParameterTypeDescription
cameraCameraComponent—
viewCameraView—
Returns:void—

public virtual void PostCameraSetup(Sandbox.CameraComponent camera, Sandbox.CameraView& modreq(System.Runtime.InteropServices.InAttribute) view)PUBLICVIRTUAL

ParameterTypeDescription
cameraCameraComponent—
viewCameraView& modreq(InAttribute)—
Returns:void—

Properties1

Showing 1 properties

public virtual int Sandbox.ICameraModifier.CameraOrder { get; set; }PUBLICVIRTUALGETSET

Lower runs first - a player's camera ~0, vehicles ~100, held weapons ~200.

Returns:int—

Write()

Previous Page

CameraOrder

Next Page

On this page

Methodspublic virtual System.Void ModifyCamera(Sandbox.CameraComponent camera, Sandbox.CameraView view)public virtual System.Void PostCameraSetup(Sandbox.CameraComponent camera, Sandbox.CameraView& modreq(System.Runtime.InteropServices.InAttribute) view)Propertiespublic virtual System.Int32 Sandbox.ICameraModifier.CameraOrder { get; set; }Metadata