ParallaxScrollingBackground

The ParallaxScrollingBackground allows to create an endlessly scrollable background, usable by SideScroller games for example. More...

Import Statement: import VPlay 2.0
Inherits:

Item

Properties

Methods

Detailed Description

The ParallaxScrollingBackground uses one or two MultiResolutionImage instances next to each other to create an endless scrollable background. This can be used to create a parallax scrolling background effect in a game. Make sure you read our tutorial about How to create mobile games for different screen sizes and resolutions to learn about the recommended size for your background images.

Mirrored Images

The property sourceImage needs to bet set or the item won't work correctly. If sourceImage2 is empty, the image declared in sourceImage is mirrored as second image. It is mirrored vertically when scrolling into y direction and horizontally when scrolling into x direction.

Every image could be mirrored, but only a correct prepared image looks well afterwards. Following picture shows an image which can be used for mirroring. Both sides have the same height at the left and right edge and a very similar appearance as seen on the left side. It will look great when Image1, Image2 and again Image1 are beside each other as seen on the right side.

In contrast to the correct image from above, the follwoing image illustrates an incorrect picture for endless scrolling. The background looks faulty when the edges and appearance do not fit accordingly as seen on the left side. The incorrect result can be seen on the right side.

Furthermore, mirroring images only effects the fluctuation of your image data and does not matter if the images are well prepared. To avoid this problem, you can create one image which is big enough and includes variation. You could also prepare two images which fit together as seen in the picture below. There is only one important criteria: The left edge of Image1 needs to fit together with the right edge of Image2 as seen on the left side. The images will fit perfectly together when Image1, Image2 and again Image1 are beside each other as seen on the right side.

Movement Support

The ParallaxScrollingBackground can only move either horizontally or vertically. Directional changes along one axis (e.g. changing from left to right) is supported. Changing from horizontal to vertical movement or vice versa is not supported.

Examples for supported directions:

Example Usage

Following examples demonstrate the usage of the ParallaxScrollingBackground.

Single Background Horizontal Movement

This example shows a single background image which leaves sourceImage2 empty to mirror sourceImage source file. The background scrolls with constant speed (10px per second) towards the left border with movementVelocity set to Qt.point(10,0). It scrolls with a ratio of 1/1 compared to its parent.

import VPlay 2.0
import QtQuick 2.0

GameWindow {

  Scene {

    ParallaxScrollingBackground {
      movementVelocity: Qt.point(10,0)
      ratio: Qt.point(1.0,1.0)
      sourceImage: "../assets/img/background-mountains.png"
    }
  }
}

Single Background Vertical Movement

This example shows a single background image which leaves sourceImage2 empty to mirror sourceImage source file. The background scrolls with constant speed (10px per second) towards the bottom border with movementVelocity set to Qt.point(0,10). It scrolls with a ratio of 1/1 compared to its parent.

import VPlay 2.0
import QtQuick 2.0

GameWindow {

  Scene {

    ParallaxScrollingBackground {
      movementVelocity: Qt.point(0,10)
      ratio: Qt.point(1.0,1.0)
      sourceImage: "../assets/img/background-wood.png"
    }
  }
}

Dual Background

This example shows two different backgrounds using sourceImage and sourceImage2. The background scrolls with constant speed (50px per second) towards the right border with movementVelocity set to Qt.point(-50,0). It scrolls with a ratio of 1/1 compared to its parent.

import VPlay 2.0
import QtQuick 2.0

GameWindow {

  Scene {

    ParallaxScrollingBackground {
      movementVelocity: Qt.point(-50,0)
      ratio: Qt.point(1.0,1.0)
      sourceImage: "../assets/img/background-hills.png"
      sourceImage2: "../assets/img/background-hills2.png"
    }
  }
}

Several ParallaxScollingBackgrounds

When a game should use different parallax effects it needs to use several items which move with different speeds. This case is demonstrated in this example.

import VPlay 2.0
import QtQuick 2.0

GameWindow {

  Scene {

    ParallaxScrollingBackground {
      movementVelocity: Qt.point(100,0)
      ratio: Qt.point(0.5,1.0)
      sourceImage: "../assets/img/background-mountains.png"
    }

    ParallaxScrollingBackground {
      id: background1
      movementVelocity: Qt.point(-100,0)
      ratio: Qt.point(1.0,1.0)
      sourceImage: "../assets/img/background-hills.png"
    }

    ParallaxScrollingBackground {
      id: background2
      movementVelocity: Qt.point(10,0)
      ratio: Qt.point(1.3,1.0)
      sourceImage: "../assets/img/background-lawn.png"
    }

  } // end of Scene

} // end of GameWindow

Also see the Parallax Test for more information about the correct usage of the ParallaxScrollingBackground.

Property Documentation

image : alias

Note: The ParallaxScrollingBackground now has the size of the used MultiResolutionImage (sourceImage) by default. You can therefore center the ParallaxScrollingBackground (or other ways of anchoring) in the scene like you would do it with any other MultiResolutionImage.

You can still read the size of the used MultiResolutionImage with the image alias like shown in the example below. In this example it is used to position the ParallaxScrollingBackground in the center of the scene, however, the recommened approach is to just set anchors.centerIn: parent.

import VPlay 2.0
import QtQuick 2.0

GameWindow {

  Scene {
    ParallaxScrollingBackground {
      id: pxBg
      sourceImage: "../assets/img/background-wood.png"
      x: -(pxBg.image.width-scene.width)/2
      y: -(pxBg.image.height-scene.height)/2
      mirrorSecondImage: false
      movementVelocity: Qt.point(-75, 0)
    }
  } // end of Scene

} // end of GameWindow

mirrorSecondImage : bool

Set this property if you want to mirror the sourceImage2 image. By default, if you only have specified the sourceImage property but no sourceImage2 property, the second image will be mirrored. If you explicitly set the sourceImage2 property, it will not be mirrored.

The mirroring is performed automatically based on the movementVelocity: if you set its x property, the image will be mirrored horizontally, or vertically when the y property is set.


movementVelocity : point

The movementVelocity property is used to set the direction and speed of the movement.

  • Left achieved with movementVelocity: Qt.point(10,0)
  • Right achieved with movementVelocity: Qt.point(-10,0)
  • Up achieved with movementVelocity: Qt.point(0,-10)
  • Down achieved with movementVelocity: Qt.point(0,10)

ratio : point

The ratio property is used to set how much shift should occur between parent and image.

  • Left/Right faster than parent achieved with ratio: Qt.point(1.5,1.0)
  • Left/Right slower than parent achieved with ratio: Qt.point(0.5,1.0)
  • Up/Down faster than parent achieved with ratio: Qt.point(1.0,1.5)
  • Up/Down slower than parent achieved with ratio: Qt.point(1.0,0.5)

running : bool

If set to true, the background images will scroll with the specified movementVelocity. If set to to false, the scrolling will pause. By default, it is set to true.


sourceImage2 : url

The sourceImage2 property is not always used. It can be used to provide an additional second image which will alternate with the sourceImage during scrolling. If the property sourceImage2 is left empty, the first image from the property sourceImage will be used and mirrored automatically.


sourceImage : url

The sourceImage property is used to provide the image data for the background. This needs to be set accordingly or the ParallaxScrollingBackground will not work correctly.


Method Documentation

resetBackgrounds()

Reset the position of the images in the ParallaxScrollingBackground.


Voted #1 for:

  • Easiest to learn
  • Most time saving
  • Best support

Develop Cross-Platform Apps and Games 50% Faster!

  • Voted the best supported, most time-saving and easiest to learn cross-platform development tool
  • Based on the Qt framework, with native performance and appearance on all platforms including iOS and Android
  • Offers a variety of plugins to monetize, analyze and engage users
FREE!
create apps
create games
cross platform
native performance
3rd party services
game network
multiplayer
level editor
easiest to learn
biggest time saving
best support
Sign up for Free and start developing right away!
I want to make Games
I want to make Apps
Game Development
Cross-Platform, Any Resolution

Use one IDE to deploy to all supported platforms, including iOS and Android, from a single code base.

Support all screen resolutions, aspect ratios and sizes with auto-adapting UI elements, smart scene scaling and memory efficient asset selection.

Learn More

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Multiplayer

V-Play Multiplayer supports both real-time and turn-based gameplay, so you can use it to make many different types of cross-platform multiplayer games. It's perfect for making player-vs-player games like 'Words with Friends' or games for a large amount of players, such as 'Clash of Clans'.

Learn More Video

Highscores & Achievements

The V-Play Game Network is a cross-platform gaming service that allows players around the world to compare game highscores and achievements. Players can also challenge each other across multiple platforms and share their progress on Facebook.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code.

import QtQuick 2.0
import VPlay 2.0

GameWindow {
  Scene {
    
    SimpleButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Level Editor

The LevelEditor can be used during development to create and modify levels for your game, which you can then bundle in your final publishing build. Additionally, you can also integrate the in-game level editor to your published game and let your gamers create new levels.

Learn More Video

Card Game like UNO, Hearthstone or Poker

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/OneCard/OneCard.pro

Match-3 like Candy Crush Saga

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquash/JuicySquash.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/JuicySquashAdvanced/JuicySquashAdvanced.pro

Puzzle like 2048 or Threes!

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/2048/2048.pro

Casino like Big Win Slots

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlaskOfRum/FlaskOfRum.pro

Side Scroller like Jetpack Joyride or Flappy Bird

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/FlappyBird/FlappyBird.pro

Tower Defense like Castle Defense or Bloons TD

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Squaby/Squaby.pro

Falldown & Jump like Doodle Jump or Mega Jump

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak/ChickenOutbreak.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/ChickenOutbreak2/ChickenOutbreak2.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/DoodleJump/DoodleJump.pro

Platformer like Super Mario or Lep's World

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/Platformer/Platformer.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Action like Angry Birds, Fruit Ninja, Cut the Rope

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/BalloonPop/BalloonPop.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/CarChallenge/CarChallenge.pro

Arcade like Arkanoid or Space Invaders

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/demos/ZombieBreak/ZombieBreak.pro

Community like Super Mario Maker or Minecraft

We got a demo game for you!

The V-Play SDK includes an open-source demo for this game genre. You can use its source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/examples/Squaby/Squaby.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/StackTheBoxWithCommunityEditor/StackTheBoxWithCommunityEditor.pro

<Path to V-PlaySDK>/Examples/V-Play/demos/PlatformerWithLevelEditor/PlatformerWithLevelEditor.pro

Any other Idea? let us know how we can help you

You are looking for another demo?

The V-Play SDK includes many open-source demos for different game genres. You can use their source code and build your game in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

If you do not find your game genre in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us

App Development
Better Apps, Less Effort

Develop feature-rich, cross-platform mobile apps from a single code base.

V-Play apps look, feel and perform exactly like native iOS, Android and Desktop apps. With less code & much faster development time.

Learn More Highlights Video

V-Play ranked #1 at research2guidance cross-platform tool benchmarking 2014 by 2188 developers comparing 40 leading tools.

Save Time, Code & Money

Save up to 90% source code with V-Play, compared to frameworks like Xamarin, Titanium, React Native and others.

Learn More

QML & JavaScript

Qt Meta Language is a highly intuitive reactive language, which is super easy to learn, yet it's extremely powerful and flexible. Mix it with JavaScript to create awesome stuff, with just a few lines of code. QML also allows you to easily create smooth and complex animations.

import QtQuick 2.0
import VPlayApps 2.0

App {
  Page {
    
    AppButton {
      anchors.centerIn: parent
      text: "Press Me"
      onClicked: {
        console.debug("Wow you pressed me!")
      }
    }
  }
}

Learn More

Monetize & Analyze

With V-Play, you can use many 3rd party services for ads, in-app purchases, analytics and more, with just a few lines of code. All of these plugins work cross-platform, which allows you to maintain a single code base.

Learn More

Native Sensors & More

V-Play Apps harness the power of Qt, the leading cross-platform development framework used by over 1,000,000 developers.

This gives your access to native device features like sensors, camera, file system as well as multimedia, networking, localization and much more.

Learn More

Responsive Design

V-Play has built in responsive design capabilities, you can target phones and tablets with the same source code.

Learn More

Highly Extensible

You have existing JavaScript, C++ or native code? You want to add any 3rd party SDK that we do not offer already?

No worries, you can add any JS, C++, Java or Objective-C code to your project.

Learn More

Component Showcase App shows the most important V-Play features and components

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/showcase/Showcase.pro

Qt World Summit Conference App a full-featured conference management app made by V-Play

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/qtws2016/QtWS2016.pro

Twitter App how to build layouts like in the official Twitter app for iOS and Android

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/twitter/Twitter.pro

Maps App displays free bikes or boxes at bike stations for Vienna's bike sharing service Citybike Wien

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/maps/Maps.pro

Messaging App demonstrates how to create the UI of a Facebook Messenger like app

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/messaging/Messaging.pro

Weather App how to include powerful animations into your user interface

We got a demo app for you!

The V-Play SDK includes an open-source demo for this app type. You can use its source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play.

<Path to V-PlaySDK>/Examples/V-Play/appdemos/waether/Weather.pro

Any other Idea? let us know how we can help you

You are looking for another app demo?

The V-Play SDK includes many open-source demos for different app types. You can use their source code and build your app in record time. After installing V-Play, you can simply open the .pro file with Qt Creator, the development environment used for V-Play..

If you do not find your app type in this list and wonder if V-Play is the right choice, just contact us, we are happy to help!

Contact Us