Orx Learning

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Part 5 – Viewport and Camera ======

In order for anything to appear in your game, you will first need both a viewport and a camera.

A viewport is the rectangle that we can view the game world through. And a camera allows us to see all or part of that world at a time.

Take a look at your MyGame.ini and you'll see that a ''[MainViewport]'' section has already been specified for you.

<code=ini>
[MainViewport]
Camera             = MainCamera
</code>

Let's give our game a blue sky as a background, by adding the ''BackgroundColor'' property to the config:

<code=ini>
[MainViewport]
Camera            = MainCamera
BackgroundColor   = (0, 180, 255)
</code>

Secondly, notice the Camera parameter is set to ''MainCamera''? This means it is set to the ''[MainCamera]'' section, which has also already been defined for you:

<code=ini>
[MainCamera]
FrustumWidth    = 1280
FrustumHeight   = 720
FrustumFar      = 2.0
FrustumNear     = 0.0
Position        = (0.0, 0.0, -1.0) ; Objects with -1 <= Z <= 1 will be visible
</code>

The ''Position'' is set to 0,0 which is in the center of the screen so that the whole screen can be viewed. The Z position is -1.0 which means the camera is set back a little from the action.        

Let's change the screen width and height so that it makes working through the tutorial easier (and easier to take screenshots :) ):

<code=ini>
[MainCamera]
FrustumWidth    = 800
FrustumHeight   = 600
FrustumFar      = 2.0
FrustumNear     = 0.0
Position        = (0.0, 0.0, -1.0) ; Objects with -1 <= Z <= 1 will be visible
</code>

A frustum width and height does not have to be the same size as your screen, but for our game, we want it to be. So the ''ScreenWidth'' and ''ScreenHeight'' values from the ''[Display]'' section are being inherited from the ''FrustumWidth'' and ''FrustumHeight'' values, as you can see at:

<code ini>
[Display]
ScreenWidth     = @MainCamera.FrustumWidth
ScreenHeight    = @MainCamera.FrustumHeight
...
</code>

The viewport needs to be created when our game runs, so let's take a look at the MyGame.cpp code:

<code=cpp>
orxSTATUS orxFASTCALL Init()
{

    orxViewport_CreateFromConfig("MainViewport");
</code>

Nice and simple. Our project already has this added. The Init() function runs once when your game first executes, and this is where the viewport is created.


The "MainViewport" string parameter specified in that function is the same name as the ''[MainViewport]'' section in the config.

Because the camera was specified in the ''[MainViewport]'' section, we do not need to create a camera in code.

Final thing for this step is to name our game. This name will show in the window title. Set this with the ''Title'' property in the ''[Display]'' section. Also while you are here, set the ''Smoothing'' to false:

<code=ini>
[Display]
ScreenWidth     = @MainCamera.FrustumWidth
ScreenHeight    = @MainCamera.FrustumHeight
Title           = Platform Hero
FullScreen      = false
Smoothing       = false
VSync           = true
</code>

This will change the name in the window title, but only if you are compiling in Release mode. You'll most likely be compiling in Debug mode right now. So you'll also need to change the title in the ''MyGamed.ini'' file:

<code ini>
[Display]
Title           = Platform Hero (Debug)
ShowFPS         = true
</code>

Compile and run to see your game window with a blue background and a default object in the center of the screen:

{{:guides:beginners:beginners-19-object-position.png?nolink|}}

----

Next: [[en:guides:beginners:objects|Part 6 – Objects]]

{{section>en:guides:beginners:toc&noheader&nofooter&noeditbutton}}
Orx Learning

User Tools

Site Tools

Page Tools
