Graphics.Rendering.Handa.Viewer

Functions for managing perspectives and frusta.

Viewer Geometry

data ViewerParameters a

Paramaters specifying a viewer, including the frustum of the view.

Constructors

ViewerParameters

Fields

• screen :: Screen a

  The screen location.

• nearPlane :: a

  The distance to the near plane of the frustum.

• farPlane :: a

  The distance to the far plane of the frustum.

• eyePosition :: Vertex3 a

  The position of the eyes.

• eyeSeparation :: Vector3 a

  The separation between the eyes.

• eyeUpward :: Vector3 a

  The upward direction.

• sceneCenter :: Vertex3 a

  The center of the scene.

• sceneScale :: Vector3 a

  The factor by which to scale the scene.

Instances

Functor ViewerParameters

Methods

fmap :: (a -> b) -> ViewerParameters a -> ViewerParameters b

(<$) :: a -> ViewerParameters b -> ViewerParameters a

Eq a => Eq (ViewerParameters a)

Methods

(==) :: ViewerParameters a -> ViewerParameters a -> Bool

(/=) :: ViewerParameters a -> ViewerParameters a -> Bool

Data a => Data (ViewerParameters a)

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ViewerParameters a -> c (ViewerParameters a)

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (ViewerParameters a)

toConstr :: ViewerParameters a -> Constr

dataTypeOf :: ViewerParameters a -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c (ViewerParameters a))

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (ViewerParameters a))

gmapT :: (forall b. Data b => b -> b) -> ViewerParameters a -> ViewerParameters a

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ViewerParameters a -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ViewerParameters a -> r

gmapQ :: (forall d. Data d => d -> u) -> ViewerParameters a -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ViewerParameters a -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ViewerParameters a -> m (ViewerParameters a)

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ViewerParameters a -> m (ViewerParameters a)

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ViewerParameters a -> m (ViewerParameters a)

Read a => Read (ViewerParameters a)

Methods

readsPrec :: Int -> ReadS (ViewerParameters a)

readList :: ReadS [ViewerParameters a]

readPrec :: ReadPrec (ViewerParameters a)

readListPrec :: ReadPrec [ViewerParameters a]

Show a => Show (ViewerParameters a)

Methods

showsPrec :: Int -> ViewerParameters a -> ShowS

show :: ViewerParameters a -> String

showList :: [ViewerParameters a] -> ShowS

Generic (ViewerParameters a)

Associated Types

type Rep (ViewerParameters a) :: * -> *

Methods

from :: ViewerParameters a -> Rep (ViewerParameters a) x

to :: Rep (ViewerParameters a) x -> ViewerParameters a

(FromJSON a, Generic a) => FromJSON (ViewerParameters a)

Methods

parseJSON :: Value -> Parser (ViewerParameters a)

parseJSONList :: Value -> Parser [ViewerParameters a]

(Binary a, Generic a) => Binary (ViewerParameters a)

Methods

put :: ViewerParameters a -> Put

get :: Get (ViewerParameters a)

putList :: [ViewerParameters a] -> Put

(Fractional a, Storable a) => Default (ViewerParameters a)

Methods

def :: ViewerParameters a

type Rep (ViewerParameters a)

type Rep (ViewerParameters a) = D1 (MetaData "ViewerParameters" "Graphics.Rendering.Handa.Viewer" "handa-opengl-0.1.12.1-1kPa5QvhFvW7EPEJhuE1zR" False) (C1 (MetaCons "ViewerParameters" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "screen") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Screen a))) (S1 (MetaSel (Just Symbol "nearPlane") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))) ((:*:) (S1 (MetaSel (Just Symbol "farPlane") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a)) (S1 (MetaSel (Just Symbol "eyePosition") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vertex3 a))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "eyeSeparation") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vector3 a))) (S1 (MetaSel (Just Symbol "eyeUpward") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vector3 a)))) ((:*:) (S1 (MetaSel (Just Symbol "sceneCenter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vertex3 a))) (S1 (MetaSel (Just Symbol "sceneScale") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Vector3 a)))))))

viewerGeometry

Arguments

:: (Fractional a, Storable a)

=> a

The width of the screen or display.

-> a

The height of the screen or display.

-> a

The distance from the eyes to the screen or display.

-> ViewerParameters a

The corresponding viewer parameters.

Construct viewer geometry from physical geometry.

displayAspectRatio

Arguments

:: (AdditiveGroup a, RealFloat a, Storable a)

=> ViewerParameters a

The viewer parameters.

-> a

The aspect ratio, namely the screen width divided by its height.

The aspect ratio of the viewer.

displayThrowRatio

Arguments

:: (AdditiveGroup a, RealFloat a, Storable a)

=> ViewerParameters a

The viewer parameters.

-> a

The throw ratio, namely the distance to the screen divided by its height.

The throw ratio of the viewer.

fieldOfView

Arguments

:: (AdditiveGroup a, RealFloat a, Storable a)

=> ViewerParameters a

The viewer parameters

-> a

The field of view, in degrees.

Compute the field of view for viewer parameters.

Typical Devices

phoneViewer :: (Fractional a, Storable a) => ViewerParameters a

Viewer parameters for a typical smartphone screen.

laptopViewer :: (Fractional a, Storable a) => ViewerParameters a

Viewer parameters for a typical laptop screen.

desktopViewer :: (Fractional a, Storable a) => ViewerParameters a

Viewer parameters for a typical desktop monitor.

projectorViewer :: (Fractional a, Storable a) => ViewerParameters a

Viewer parameters for a typical projector.

Callbacks and Rendering

reshape

Arguments

:: (AdditiveGroup a, MatrixComponent a, RealFloat a, Storable a)

=> ViewerParameters a

The viewer parameters.

-> ReshapeCallback

The reshape callback.

Construct a reshape callback from viewer parameters. This simply sets the frustum based on the viewer parameters and the size of the viewport.

loadViewer

Arguments

:: (AdditiveGroup a, MatrixComponent a, RealFloat a, Storable a)

=> Bool

Whether to use an on-axis projection.

-> ViewerParameters a

The viewer parameters.

-> DlpEye

The eye from which to view.

-> IO ()

An action for looking at the scene using the specified eye and viewer parameters.

Create an action look at the scene according to the viewer parameters.

dlpViewerDisplay

Arguments

:: (AdditiveGroup a, MatrixComponent a, RealFloat a, Storable a)

=> Bool

Whether to use on-axis projection.

-> DlpEncoding

The DLP encoding.

-> ViewerParameters a

The viewer parameters.

-> DisplayCallback

The display callback.

-> DlpDisplay

The DLP display data for using the specified encoding, viewer parameters, and display callback.

Construct a DLP display from a display callback.

dlpViewerDisplay'

Arguments

:: (AdditiveGroup a, MatrixComponent a, RealFloat a, Storable a)

=> Bool

Whether to use on-axis projection.

-> DlpEncoding

The DLP encoding.

-> IORef (ViewerParameters a)

A reference to the viewer parameters.

-> DisplayCallback

The display callback.

-> DlpDisplay

The DLP display data for using the specified encoding, viewer parameters, and display callback.

Construct a DLP display from a display callback.