Camera

Camera node, displays from a point of view.

Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest Viewport node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the camera will register in the global viewport. In other words, a camera just provides 3D display capabilities to a Viewport, and, without one, a scene registered in that Viewport (or higher viewports) can't be displayed.

@GodotBaseClass

struct Camera {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(Camera other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static Camera _new();

enum KeepAspect;

enum Projection;

enum DopplerTracking;

enum Constants;

void clearCurrent(bool enable_next);

RID getCameraRid();

Transform getCameraTransform();

long getCullMask();

bool getCullMaskBit(long layer);

Camera.DopplerTracking getDopplerTracking();

Ref!Environment getEnvironment();

double getFov();

Array getFrustum();

Vector2 getFrustumOffset();

double getHOffset();

Camera.KeepAspect getKeepAspectMode();

Camera.Projection getProjection();

double getSize();

double getVOffset();

double getZfar();

double getZnear();

bool isCurrent();

bool isPositionBehind(Vector3 world_point);

void makeCurrent();

Vector3 projectLocalRayNormal(Vector2 screen_point);

Vector3 projectPosition(Vector2 screen_point, double z_depth);

Vector3 projectRayNormal(Vector2 screen_point);

Vector3 projectRayOrigin(Vector2 screen_point);

void setCullMask(long mask);

void setCullMaskBit(long layer, bool enable);

void setCurrent(bool arg0);

void setDopplerTracking(long mode);

void setEnvironment(Environment env);

void setFov(double arg0);

void setFrustum(double size, Vector2 offset, double z_near, double z_far);

void setFrustumOffset(Vector2 arg0);

void setHOffset(double ofs);

void setKeepAspectMode(long mode);

void setOrthogonal(double size, double z_near, double z_far);

void setPerspective(double fov, double z_near, double z_far);

void setProjection(long arg0);

void setSize(double arg0);

void setVOffset(double ofs);

void setZfar(double arg0);

void setZnear(double arg0);

Vector2 unprojectPosition(Vector3 world_point);

long cullMask [@property getter];

long cullMask [@property setter];

bool current [@property getter];

bool current [@property setter];

Camera.DopplerTracking dopplerTracking [@property getter];

long dopplerTracking [@property setter];

Environment environment [@property getter];

Environment environment [@property setter];

double far [@property getter];

double far [@property setter];

double fov [@property getter];

double fov [@property setter];

Vector2 frustumOffset [@property getter];

Vector2 frustumOffset [@property setter];

double hOffset [@property getter];

double hOffset [@property setter];

Camera.KeepAspect keepAspect [@property getter];

long keepAspect [@property setter];

double near [@property getter];

double near [@property setter];

Camera.Projection projection [@property getter];

long projection [@property setter];

double size [@property getter];

double size [@property setter];

double vOffset [@property getter];

double vOffset [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
DopplerTracking enum DopplerTracking
KeepAspect enum KeepAspect
Projection enum Projection

Functions

clearCurrent void clearCurrent(bool enable_next): If this is the current camera, remove it from being current. If enable_next is true, request to make the next camera current, if any.
getCameraRid RID getCameraRid(): Returns the camera's RID from the VisualServer.
getCameraTransform Transform getCameraTransform(): Gets the camera transform. Subclassed cameras such as InterpolatedCamera may provide different transforms than the Node transform.
getCullMask long getCullMask()
getCullMaskBit bool getCullMaskBit(long layer): Returns true if the given layer in the cullMask is enabled, false otherwise.
getDopplerTracking Camera.DopplerTracking getDopplerTracking()
getEnvironment Ref!Environment getEnvironment()
getFov double getFov()
getFrustum Array getFrustum(): Returns the camera's frustum planes in world space units as an array of Planes in the following order: near, far, left, top, right, bottom. Not to be confused with frustumOffset.
getFrustumOffset Vector2 getFrustumOffset()
getHOffset double getHOffset()
getKeepAspectMode Camera.KeepAspect getKeepAspectMode()
getProjection Camera.Projection getProjection()
getSize double getSize()
getVOffset double getVOffset()
getZfar double getZfar()
getZnear double getZnear()
isCurrent bool isCurrent()
isPositionBehind bool isPositionBehind(Vector3 world_point): Returns true if the given position is behind the camera. Note: A position which returns false may still be outside the camera's field of view.
makeCurrent void makeCurrent(): Makes this camera the current camera for the Viewport (see class description). If the camera node is outside the scene tree, it will attempt to become current once it's added.
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(Camera other)
opEquals bool opEquals(typeof(null) n)
projectLocalRayNormal Vector3 projectLocalRayNormal(Vector2 screen_point): Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc.
projectPosition Vector3 projectPosition(Vector2 screen_point, double z_depth): Returns the 3D point in world space that maps to the given 2D coordinate in the Viewport rectangle on a plane that is the given z_depth distance into the scene away from the camera.
projectRayNormal Vector3 projectRayNormal(Vector2 screen_point): Returns a normal vector in world space, that is the result of projecting a point on the Viewport rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
projectRayOrigin Vector3 projectRayOrigin(Vector2 screen_point): Returns a 3D position in world space, that is the result of projecting a point on the Viewport rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking.
setCullMask void setCullMask(long mask)
setCullMaskBit void setCullMaskBit(long layer, bool enable): Enables or disables the given layer in the cullMask.
setCurrent void setCurrent(bool arg0)
setDopplerTracking void setDopplerTracking(long mode)
setEnvironment void setEnvironment(Environment env)
setFov void setFov(double arg0)
setFrustum void setFrustum(double size, Vector2 offset, double z_near, double z_far): Sets the camera projection to frustum mode (see constant PROJECTION_FRUSTUM), by specifying a size, an offset, and the z_near and z_far clip planes in world space units.
setFrustumOffset void setFrustumOffset(Vector2 arg0)
setHOffset void setHOffset(double ofs)
setKeepAspectMode void setKeepAspectMode(long mode)
setOrthogonal void setOrthogonal(double size, double z_near, double z_far): Sets the camera projection to orthogonal mode (see constant PROJECTION_ORTHOGONAL), by specifying a size, and the z_near and z_far clip planes in world space units. (As a hint, 2D games often use this projection, with values specified in pixels.)
setPerspective void setPerspective(double fov, double z_near, double z_far): Sets the camera projection to perspective mode (see constant PROJECTION_PERSPECTIVE), by specifying a fov (field of view) angle in degrees, and the z_near and z_far clip planes in world space units.
setProjection void setProjection(long arg0)
setSize void setSize(double arg0)
setVOffset void setVOffset(double ofs)
setZfar void setZfar(double arg0)
setZnear void setZnear(double arg0)
toHash size_t toHash()
unprojectPosition Vector2 unprojectPosition(Vector3 world_point): Returns the 2D coordinate in the Viewport rectangle that maps to the given 3D point in world space. Note: When using this to position GUI elements over a 3D viewport, use isPositionBehind to prevent them from appearing if the 3D point is behind the camera:

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

cullMask long cullMask [@property getter]
long cullMask [@property setter]: The culling mask that describes which 3D render layers are rendered by this camera.
current bool current [@property getter]
bool current [@property setter]: If true, the ancestor Viewport is currently using this camera.
dopplerTracking Camera.DopplerTracking dopplerTracking [@property getter]
long dopplerTracking [@property setter]: If not constant DOPPLER_TRACKING_DISABLED, this camera will simulate the url=https://en.wikipedia.org/wiki/Doppler_effectDoppler effect/url for objects changed in particular _process methods. See dopplertracking for possible values.
environment Environment environment [@property getter]
Environment environment [@property setter]: The Environment to use for this camera.
far double far [@property getter]
double far [@property setter]: The distance to the far culling boundary for this camera relative to its local Z axis.
fov double fov [@property getter]
double fov [@property setter]: The camera's field of view angle (in degrees). Only applicable in perspective mode. Since keepAspect locks one axis, fov sets the other axis' field of view angle. For reference, the default vertical field of view value (70.0) is equivalent to a horizontal FOV of: - ~86.07 degrees in a 4:3 viewport - ~96.50 degrees in a 16:10 viewport - ~102.45 degrees in a 16:9 viewport - ~117.06 degrees in a 21:9 viewport
frustumOffset Vector2 frustumOffset [@property getter]
Vector2 frustumOffset [@property setter]: The camera's frustum offset. This can be changed from the default to create "tilted frustum" effects such as url=https://zdoom.org/wiki/Y-shearingY-shearing/url.
hOffset double hOffset [@property getter]
double hOffset [@property setter]: The horizontal (X) offset of the camera viewport.
keepAspect Camera.KeepAspect keepAspect [@property getter]
long keepAspect [@property setter]: The axis to lock during fov/size adjustments. Can be either constant KEEP_WIDTH or constant KEEP_HEIGHT.
near double near [@property getter]
double near [@property setter]: The distance to the near culling boundary for this camera relative to its local Z axis.
projection Camera.Projection projection [@property getter]
long projection [@property setter]: The camera's projection mode. In constant PROJECTION_PERSPECTIVE mode, objects' Z distance from the camera's local space scales their perceived size.
size double size [@property getter]
double size [@property setter]: The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since keepAspect locks on axis, size sets the other axis' size length.
vOffset double vOffset [@property getter]
double vOffset [@property setter]: The vertical (Y) offset of the camera viewport.

Static functions

_new Camera _new(): Construct a new instance of Camera. Note: use memnew!Camera instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot camera modules

all

structs

Camera