.. index:: pair: class; EE::Graphics::ScrollParallax
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax:

class EE::Graphics::ScrollParallax
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

The scroll parallax renders a :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` to the screen from a position and a size specified. If the size is bigger than the :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>`, the :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` is rendered as a repeated :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` until it covers all the size of the parallax, adding movement to more than one Scroll Parallax will generate the ilusion of depth. \* More info in wikipedia: `http://en.wikipedia.org/wiki/Parallax_scrolling <http://en.wikipedia.org/wiki/Parallax_scrolling>`__. :ref:`More...<details-class_e_e_1_1_graphics_1_1_scroll_parallax>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <scrollparallax.hpp>
	
	class ScrollParallax {
	public:
		// construction
	
		:target:`ScrollParallax<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1acb56d2170bbf21268bf27ef6f88a70f3>`();
		:ref:`ScrollParallax<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1ae16d24b3e333b898cacd7074f10d6e6d>`(:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* textureRegion, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size = :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`(), const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& speed = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& color = Color::White, const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& Blend = :ref:`BlendMode::Alpha<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d7b3de926b178d2ac3e2e081bf71d86>`());
		:target:`~ScrollParallax<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1ab506a58ef4c69764ca608a89707bc509>`();

		// methods
	
		bool :ref:`create<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a61a0eef48f8e3392ce00d0c4045520de>`(:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* textureRegion, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size = :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`(), const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& speed = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& color = Color::White, const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& Blend = :ref:`BlendMode::Alpha<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d7b3de926b178d2ac3e2e081bf71d86>`());
		void :ref:`setColor<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a19ac9e5533b10372b307e3a2beb73203>`(const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& Color);
		:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>` :ref:`getColor<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a09f61ca9c7b0faa2a7441d7ba915c15b>`() const;
		void :ref:`setBlendMode<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a617fd44f9d54b3bb93013340b4de43ee>`(const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& Blend);
		const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& :ref:`getBlendMode<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a3660e6d4fa44fd9ceb413dad44c76d4e>`() const;
		void :ref:`draw<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a5e23bbc60d04f0599fdcbddedce97c04>`();
		void :ref:`setSize<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1ae3a5e2be65a1659ae4df70c6c2fb4f24>`(const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size);
		const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& :ref:`getSize<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a4a3ced22eccf118d5ae8b0258034e08c>`() const;
		void :ref:`setPosition<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1ad4f0ac634a43dc4925deba4a70a83e16>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& Pos);
		const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& :ref:`getPosition<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a21164468a7a3eb70ec1a176587bb9245>`() const;
		:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* :ref:`getTextureRegion<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1aec7bceb780bd84712ea341569ed221fd>`() const;
		void :ref:`setTextureRegion<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a10cfb7a9bb1c5736911e2d1baa271acc>`(:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* textureRegion);
		void :ref:`setSpeed<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1acf5397bdb5f29e6aca4373ccc10aa2f4>`(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& speed);
		const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& :ref:`getSpeed<doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a3d1e9ac724f6b8ae4e830c53c340618b>`() const;
	};
.. _details-class_e_e_1_1_graphics_1_1_scroll_parallax:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

The scroll parallax renders a :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` to the screen from a position and a size specified. If the size is bigger than the :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>`, the :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` is rendered as a repeated :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` until it covers all the size of the parallax, adding movement to more than one Scroll Parallax will generate the ilusion of depth. \* More info in wikipedia: `http://en.wikipedia.org/wiki/Parallax_scrolling <http://en.wikipedia.org/wiki/Parallax_scrolling>`__.

Construction
------------

.. index:: pair: function; ScrollParallax
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1ae16d24b3e333b898cacd7074f10d6e6d:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	ScrollParallax(:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* textureRegion, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size = :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`(), const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& speed = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& color = Color::White, const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& Blend = :ref:`BlendMode::Alpha<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d7b3de926b178d2ac3e2e081bf71d86>`())

Constructor that create's the Scroll Parallax



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- textureRegion

		- The :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` to Draw

	*
		- position

		- The position of the parallax

	*
		- size

		- The size of the parallax

	*
		- speed

		- Speed of movement ( in Pixels Per Second )

	*
		- color

		- The :ref:`Texture <doxid-class_e_e_1_1_graphics_1_1_texture>` Color

	*
		- Blend

		- The Blend Mode ( default :ref:`BlendMode::Alpha() <doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d7b3de926b178d2ac3e2e081bf71d86>`)

Methods
-------

.. index:: pair: function; create
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a61a0eef48f8e3392ce00d0c4045520de:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	bool create(:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* textureRegion, const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& position = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size = :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`(), const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& speed = :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`(), const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& color = Color::White, const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& Blend = :ref:`BlendMode::Alpha<doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d7b3de926b178d2ac3e2e081bf71d86>`())

Create's the Scroll Parallax



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- textureRegion

		- The :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` to Draw

	*
		- position

		- The position of the parallax

	*
		- size

		- The size of the parallax

	*
		- speed

		- Speed of movement ( in Pixels Per Second )

	*
		- color

		- The :ref:`Texture <doxid-class_e_e_1_1_graphics_1_1_texture>` Color

	*
		- Blend

		- The Blend Mode ( default :ref:`BlendMode::Alpha() <doxid-class_e_e_1_1_graphics_1_1_blend_mode_1a4d7b3de926b178d2ac3e2e081bf71d86>`)



.. rubric:: Returns:

True if success

.. index:: pair: function; setColor
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a19ac9e5533b10372b307e3a2beb73203:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setColor(const :ref:`Color<doxid-class_e_e_1_1_system_1_1_color>`& Color)

Set the parallax texture color.

.. index:: pair: function; getColor
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a09f61ca9c7b0faa2a7441d7ba915c15b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`Color<doxid-class_e_e_1_1_system_1_1_color>` getColor() const

Get the parallax texture color.

.. index:: pair: function; setBlendMode
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a617fd44f9d54b3bb93013340b4de43ee:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setBlendMode(const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& Blend)

Set the Blend Mode used.

.. index:: pair: function; getBlendMode
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a3660e6d4fa44fd9ceb413dad44c76d4e:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`BlendMode<doxid-class_e_e_1_1_graphics_1_1_blend_mode>`& getBlendMode() const



.. rubric:: Returns:

The Blend Mode used for the parallax.

.. index:: pair: function; draw
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a5e23bbc60d04f0599fdcbddedce97c04:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void draw()

Draw the Scroll Parallax.

.. index:: pair: function; setSize
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1ae3a5e2be65a1659ae4df70c6c2fb4f24:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setSize(const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& size)

Change the size of the current parallax



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- size

		- The new size

.. index:: pair: function; getSize
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a4a3ced22eccf118d5ae8b0258034e08c:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Sizef<doxid-namespace_e_e_1_1_math_1a86ff02633aa946b0cc0d2c6ef97a3e2d>`& getSize() const



.. rubric:: Returns:

Size

.. index:: pair: function; setPosition
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1ad4f0ac634a43dc4925deba4a70a83e16:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setPosition(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& Pos)

Change the Parallax position



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- Pos

		- The new parallax position

.. index:: pair: function; getPosition
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a21164468a7a3eb70ec1a176587bb9245:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& getPosition() const



.. rubric:: Returns:

The parallax position

.. index:: pair: function; getTextureRegion
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1aec7bceb780bd84712ea341569ed221fd:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* getTextureRegion() const



.. rubric:: Returns:

The :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` used for the parallax.

.. index:: pair: function; setTextureRegion
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a10cfb7a9bb1c5736911e2d1baa271acc:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setTextureRegion(:ref:`TextureRegion<doxid-class_e_e_1_1_graphics_1_1_texture_region>`* textureRegion)

Set Change the :ref:`TextureRegion <doxid-class_e_e_1_1_graphics_1_1_texture_region>` used for the parallax.

.. index:: pair: function; setSpeed
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1acf5397bdb5f29e6aca4373ccc10aa2f4:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	void setSpeed(const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& speed)

Set the parallax speed movement.

.. index:: pair: function; getSpeed
.. _doxid-class_e_e_1_1_graphics_1_1_scroll_parallax_1a3d1e9ac724f6b8ae4e830c53c340618b:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	const :ref:`Vector2f<doxid-namespace_e_e_1_1_math_1aaa8cd8ce0171a987a016e67d601f9ddb>`& getSpeed() const



.. rubric:: Returns:

The parallax movement speed.