Search Results for

    Show / Hide Table of Contents

    Class Camera2D

    This class represent a camera in a 3D world. Cameras are the devices that capture and display the world to the player.

    Inheritance
    object
    IdentifiableObject
    DependencyObject
    AttachableObject
    PrefabInstanceObject
    Component
    Camera
    Camera2D
    Implements
    IDependencyObject
    Inherited Members
    Camera.HaltonSequence
    Camera.boundingFrustum
    Camera.viewport
    Camera.ScreenViewport
    Camera.view
    Camera.viewInverse
    Camera.projection
    Camera.unjitteredProjection
    Camera.customProjection
    Camera.renderProjection
    Camera.projectionInverse
    Camera.viewProjection
    Camera.unjitteredViewProjection
    Camera.renderViewProjection
    Camera.viewProjectionInverse
    Camera.previousViewProjectionFlipped
    Camera.cachedPosition
    Camera.jitteringEnabled
    Camera.jitter
    Camera.previousJitter
    Camera.fieldOfView
    Camera.fieldOfViewAxis
    Camera.focalLength
    Camera.sensorSize
    Camera.aspectRatio
    Camera.farPlane
    Camera.nearPlane
    Camera.width
    Camera.height
    Camera.viewportWidth
    Camera.viewportHeight
    Camera.viewportFactor
    Camera.minZ
    Camera.maxZ
    Camera.dirtyPosition
    Camera.dirtyProjection
    Camera.dirtyView
    Camera.dirtyViewProjection
    Camera.unjitteredDirtyViewProjection
    Camera.dirtyPreviousViewProjection
    Camera.dirtyMultiview
    Camera.frameBuffer
    Camera.TargetFrameBuffer
    Camera.graphicsPresenter
    Camera.clearFlags
    Camera.clearDepth
    Camera.clearStencil
    Camera.backgroundColor
    Camera.ev100
    Camera.exposure
    Camera.aperture
    Camera.shutterSpeed
    Camera.sensitivity
    Camera.compensation
    Camera.OnCameraOrderChanged
    Camera.OnRenderPathChanged
    Camera.RenderManager
    Camera.DisplayTagDirty
    Camera.multiviewProperties
    Camera.MultiviewProjection
    Camera.MultiviewView
    Camera.MultiviewViewProjection
    Camera.MultiviewProjectionInverse
    Camera.MultiviewPosition
    Camera.EyeCount
    Camera.IsStereoEnabled
    Camera.FrameBufferUpdateCounter
    Camera.DrawContext
    Camera.TagFilter
    Camera.CameraShouldRender
    Camera.FrustumCullingEnabled
    Camera.LayerMaskDefaultValue
    Camera.Position
    Camera.Jitter
    Camera.PreviousJitter
    Camera.BoundingFrustum
    Camera.Projection
    Camera.UnjitteredProjection
    Camera.RenderProjection
    Camera.ProjectionInverse
    Camera.CustomProjection
    Camera.View
    Camera.ViewInverse
    Camera.ViewProjection
    Camera.UnjitteredViewProjection
    Camera.RenderViewProjection
    Camera.ViewProjectionInverse
    Camera.RenderViewProjectionInverse
    Camera.PreviousViewProjection
    Camera.BackgroundColor
    Camera.LinearBackgroundColor
    Camera.ClearFlags
    Camera.ClearDepth
    Camera.ClearStencil
    Camera.UsePhysicalParameters
    Camera.FieldOfViewAxis
    Camera.FieldOfView
    Camera.FocalLength
    Camera.SensorSize
    Camera.FarPlane
    Camera.NearPlane
    Camera.AutoExposureEnabled
    Camera.MinLogLuminance
    Camera.LogLuminanceRange
    Camera.TAU
    Camera.EV100
    Camera.AutoDepthBounds
    Camera.Exposure
    Camera.Aperture
    Camera.ShutterSpeed
    Camera.Sensitivity
    Camera.Compensation
    Camera.FocalDistance
    Camera.FrameBuffer
    Camera.Display
    Camera.DisplayTag
    Camera.CameraOrder
    Camera.LayerMask
    Camera.Viewport
    Camera.IsClipDepthZeroToOne
    Camera.FlipYProjection
    Camera.RenderPath
    Camera.CullingSystem
    Camera.HDREnabled
    Camera.JitteringEnabled
    Camera.CalculateRay(ref Vector2, out Ray)
    Camera.WorldToScreen(ref Vector3)
    Camera.WorldToScreen(ref Vector3, out Vector3)
    Camera.ScreenToWorld(ref Vector3)
    Camera.ScreenToWorld(ref Vector3, out Vector3)
    Camera.SetCustomProjection(ref Matrix4x4)
    Camera.SetCustomProjection(Matrix4x4)
    Camera.ResetCustomProjection()
    Camera.UnsuscribeDisplayEvents()
    Camera.SuscribeDisplayEvents()
    Camera.RefreshFrameBuffer()
    Camera.RefreshViewProjection()
    Camera.RefreshUnjitteredViewProjection()
    Camera.PreRender()
    Camera.PostRender()
    Camera.OnPositionChanged()
    Camera.RefreshAspectRatio()
    Camera.WithinEpsilon(float, float)
    Camera.SetStereoProperties(ViewProperties[])
    Camera.RefreshStereoProperties()
    Camera.AddAdditionalDirectives(List<string>)
    Camera.RefreshPhysicalFieldOfView()
    Camera.UpdateJittering(ref Matrix4x4)
    Component.Owner
    Component.Managers
    Component.ShouldBeActivated
    Component.Clone()
    Component.Attach(Entity)
    Component.OnLoaded()
    Component.OnActivated()
    Component.Start()
    Component.OnDeactivated()
    Component.OnDestroy()
    PrefabInstanceObject.PrefabSource
    PrefabInstanceObject.PrefabElementId
    PrefabInstanceObject.IsPrefabInstance
    PrefabInstanceObject.IsMissingPrefabSource
    AttachableObject.AttachableStateChanged
    AttachableObject.IsEnabled
    AttachableObject.State
    AttachableObject.IsLoaded
    AttachableObject.IsAttached
    AttachableObject.IsActivated
    AttachableObject.IsStarted
    AttachableObject.IsDestroyed
    AttachableObject.Destroy()
    AttachableObject.DependencyBroken()
    DependencyObject.Dependencies
    DependencyObject.OnDependencyRemoved
    IdentifiableObject.Id
    IdentifiableObject.IdHasChanged(Guid)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Evergine.Framework.Graphics
    Assembly: Evergine.Framework.dll
    Syntax
    public class Camera2D : Camera, IDependencyObject

    Constructors

    Camera2D()

    Initializes a new instance of the Camera2D class.

    Declaration
    public Camera2D()

    Fields

    IgnoreVirtualScreenRefresh

    If true, it ignores the virtual screen refresh events.

    Declaration
    public bool IgnoreVirtualScreenRefresh
    Field Value
    Type Description
    bool

    upVector

    Up vector.

    Declaration
    protected Vector3 upVector
    Field Value
    Type Description
    Vector3

    Properties

    DrawablesToRender

    Gets the drawable type that this camera should render.

    Declaration
    public override DrawableType DrawablesToRender { get; }
    Property Value
    Type Description
    DrawableType
    Overrides
    Camera.DrawablesToRender

    HasPerspective

    Gets a value indicating whether this camera is using perspective projection. This indicate that the FieldOfView is lower than 1º.

    Declaration
    public bool HasPerspective { get; }
    Property Value
    Type Description
    bool

    Transform

    Gets the camera transform.

    Declaration
    public Transform2D Transform { get; }
    Property Value
    Type Description
    Transform2D

    UpVector

    Gets or sets the vector.

    Declaration
    public Vector3 UpVector { get; set; }
    Property Value
    Type Description
    Vector3

    VanishingPoint

    Gets or sets the vanishing point of the Camera 2D. It indicates the point of the screen where the perspective is focused. Its values are included in [0, 1] where (0, 0) indicates the top left corner. Such values are percentages where 1 means the 100% of the rectangle's width/height.

    Declaration
    public Vector2 VanishingPoint { get; set; }
    Property Value
    Type Description
    Vector2
    Remarks

    The default value is [0.5f, 0.5f].

    Methods

    OnAttached()

    Attach the camera to the system.

    Declaration
    protected override bool OnAttached()
    Returns
    Type Description
    bool

    True if all is OK.

    Overrides
    Camera.OnAttached()

    OnDetach()

    Detach the camera to the system.

    Declaration
    protected override void OnDetach()
    Overrides
    Camera.OnDetach()

    RefreshDimensions()

    Refresh the with and height of the camera.

    Declaration
    protected override void RefreshDimensions()
    Overrides
    Camera.RefreshDimensions()

    RefreshProjection()

    Calculate the projection matrix.

    Declaration
    protected override void RefreshProjection()
    Overrides
    Camera.RefreshProjection()

    RefreshView()

    Refresh the view matrix.

    Declaration
    protected override void RefreshView()
    Overrides
    Camera.RefreshView()

    Unproject(ref Vector2, out Vector2)

    Unprojects the specified source.

    Declaration
    public void Unproject(ref Vector2 source, out Vector2 result)
    Parameters
    Type Name Description
    Vector2 source

    The source.

    Vector2 result

    Unprojected position.

    Implements

    IDependencyObject

    Extension Methods

    ReflectionHelper.GetMemberAssembly(object)
    ReflectionHelper.GetTypeName(object)
    In This Article
    Back to top
    Generated by DocFX