This article's documentation is for anything that uses the Source engine. Click here for more information.

Point camera: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Technical limitations)
 
(64 intermediate revisions by 33 users not shown)
Line 1: Line 1:
{{wrongtitle|title=point_camera}}
{{LanguageBar}}
{{CD|CPointCamera|file1=point_camera.cpp}}
{{this is a|point entity|name=point_camera}}


== Entity Description ==
[[File: point_viewcontrol.png | right | 300px]] It is a camera which outputs its view to the <code>_rt_camera</code> texture, which can be displayed using materials such as <code>dev/dev_tvmonitor1a</code>. The camera image will only update if a {{ent|func_monitor}} or the entity specified in an {{ent|info_camera_link}} is on-screen. Since there is normally only one camera render texture, only one camera can be active at a time unless a mod increases the limit.
Camera entity. The view of this camera can be output in realtime to a [[func_monitor]]'s monitor surface, or altenately (using [[info_camera_link]]) to any named brush entity using the correct monitor texture.


== Keys ==
{{note|This entity is missing from {{csgo}}{{insurgency}}{{l4d2}}{{css}} FGDs. {{l4d2}} uses [[point_viewcontrol_survivor]] for each survivor, or [[point_viewcontrol_multiplayer]] for all survivors at once instead.}}
{{bug|{{portal2}} In Portal 2, having a <code>point_camera</code> active can cause objects to become invisible through portals.}}
:{{workaround|Disable <code>r_portal_fastpath</code> using a {{ent|point_clientcommand}}, this allows cameras and several other portal-related things to work correctly.}}


__TOC__
{{clr}}


'''Parent parentname <target_destination>''' The name of this entity's parent in the movement hierarchy. Entities with parents move with their parent.
==Keyvalues==
 
{{KV Targetname}}
'''Pitch Yaw Roll (Y Z X) angles <angle>''' This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
{{KV Angles}}
 
{{KV|FOV|intn=FOV|float|Field of view in degrees. 90 is a good starting point for a decent view. Lower value is narrower and a larger value is a wider view.}}
'''spawnflags spawnflags <flags>'''
{{KV|Screen Aspect Ratio|intn=UseScreenAspectRatio|boolean|{{clarify}}}}
 
{{KV|Use HD Camera?|only={{hl2}} 20th|intn=UseHDCamera|boolean|Render to the [[render target]] at higher resolution.}}
'''Name targetname <target_source>''' The name that other entities refer to this entity by. This is the value used for a [[func_monitor]]'s Camera name key to bind its view.
{{minititle|Fog}}
 
{{KV|Fog Enable|intn=fogEnable|boolean}}
'''FOV FOV <float>''' Field of view in degrees. 90 is a good starting point for a decent view. Lower value is narrower and a larger value is a wider view.
{{KV|Fog Color|intn=fogColor|color255|The fog color.}}
 
{{KV|Fog Color (HDR Override)|only={{hl2}} 20th|intn=fogColor_HDR|color255|The fog color for HDR.}}
'''Screen Aspect Ratio UseScreenAspectRatio <choices>'''
{{KV|Fog Start|intn=fogStart|float|The near fog plane.}}
 
{{KV|Fog End|intn=fogEnd|float|The far fog/clipping plane.}}
'''Fog Enable fogEnable <choices>'''
{{KV|Fog Max Density [0..1]|intn=fogMaxDensity|float|The maximum fog density. 0=no fog, 1=full fog.}}
 
{{KV|Use Radial Fog?|only={{hl2}} 20th, {{hls}}, {{tf2branch}}, {{portal}}|intn=fogRadial|boolean|Use radial fog instead of planar-based fog. Only in {{hl2|1}} 20th Anniversary Update, {{hls|1}} (which runs on top of HL2 20th Anniversary base), {{portal|1}} (since May 2025 update), aswell as all games on {{tf2branch|1}} (since Feb 18, 2025 update).}}
'''Fog Color fogColor <color255>'''
 
'''Fog Start fogStart <float>''' The near fog plane.
 
'''Fog End fogEnd <float>''' The far fog/clipping plane.
 


==Flags==
{{fl|1|Start Off}}


== Inputs ==
== Inputs ==
{{I|ChangeFOV|Changes camera's FOV over time<br>Format: <code>&lt;Target FOV&gt; &lt;Time&gt;</code>|param=string}}
{{I|SetOnAndTurnOthersOff|Turn the camera on, and turn all other cameras off.}}
{{I|SetOn|Turn the camera on.}}
{{I|SetOff|Turn the camera off.}}


'''SetParent <string>''' Changes the entity's parent in the movement hierarchy.
[[Category:Entities]][[Category:Camera]]
 
'''SetParentAttachment <string>''' Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
 
'''ClearParent''' Removes this entity from the the movement hierarchy, leaving it free to move independently.
 
'''ChangeFOV <string>''' Changes camera's FOV over time
 
'''SetOnAndTurnOthersOff''' Turn the camera on, and turn all other cameras off.
 
'''SetOn''' Turn the camera on.
 
'''SetOff''' Turn the camera off.
 
 
----
''See Also''
 
[[List of entities]]

Latest revision as of 19:49, 29 November 2025

English (en)Translate (Translate)
C++ Class hierarchy
CPointCamera
↳CBaseEntity
C++ point_camera.cpp

point_camera is a point entity available in all Source Source games.

Point viewcontrol.png

It is a camera which outputs its view to the _rt_camera texture, which can be displayed using materials such as dev/dev_tvmonitor1a. The camera image will only update if a func_monitor or the entity specified in an info_camera_link is on-screen. Since there is normally only one camera render texture, only one camera can be active at a time unless a mod increases the limit.

Note.pngNote:This entity is missing from Counter-Strike: Global OffensiveInsurgencyLeft 4 Dead 2Counter-Strike: Source FGDs. Left 4 Dead 2 uses point_viewcontrol_survivor for each survivor, or point_viewcontrol_multiplayer for all survivors at once instead.
Icon-Bug.pngBug:Portal 2 In Portal 2, having a point_camera active can cause objects to become invisible through portals.  [todo tested in ?]
PlacementTip.pngWorkaround:Disable r_portal_fastpath using a point_clientcommand, this allows cameras and several other portal-related things to work correctly.

Keyvalues

Name (targetname) <string>
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also: Generic Keyvalues, Inputs and Outputs available to all entities
Pitch Yaw Roll (Y Z X) (angles) <QAngle>
This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.
FOV (FOV) <float>
Field of view in degrees. 90 is a good starting point for a decent view. Lower value is narrower and a larger value is a wider view.
Screen Aspect Ratio (UseScreenAspectRatio) <boolean>
[Clarify]
Use HD Camera? (UseHDCamera) <boolean> (only in Half-Life 2 20th)
Render to the render target at higher resolution.

Fog:

Fog Enable (fogEnable) <boolean>
Fog Color (fogColor) <color255>
The fog color.
Fog Color (HDR Override) (fogColor_HDR) <color255> (only in Half-Life 2 20th)
The fog color for HDR.
Fog Start (fogStart) <float>
The near fog plane.
Fog End (fogEnd) <float>
The far fog/clipping plane.
Fog Max Density [0..1] (fogMaxDensity) <float>
Use Radial Fog? (fogRadial) <boolean> (only in Half-Life 2 20th, Half-Life: Source, Team Fortress 2 branch, Portal)
Use radial fog instead of planar-based fog. Only in Half-Life 2 20th Anniversary Update, Half-Life: Source (which runs on top of HL2 20th Anniversary base), Portal (since May 2025 update), aswell as all games on Team Fortress 2 branch (since Feb 18, 2025 update).

Flags

Start Off : [1]

Inputs

ChangeFOV <stringRedirectInput/string>
Changes camera's FOV over time
Format: <Target FOV> <Time>
SetOnAndTurnOthersOff
Turn the camera on, and turn all other cameras off.
SetOn
Turn the camera on.
SetOff
Turn the camera off.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Point_camera&oldid=493314"