.. index:: pair: class; EE::Graphics::ClippingMask
.. _doxid-class_e_e_1_1_graphics_1_1_clipping_mask:

class EE::Graphics::ClippingMask
================================

.. toctree::
	:hidden:

	enum_EE_Graphics_ClippingMask_Mode.rst

Overview
~~~~~~~~




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

	#include <clippingmask.hpp>
	
	class ClippingMask {
	public:
		// enums
	
		enum :ref:`Mode<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a32a4a593e1b94c3c66dc6b9c5b7d5188>`;

		// methods
	
		void :ref:`clipEnable<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1adedbe111ec1b7ba73265574b5c6338ad>`(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& x, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& y, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Width, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Height);
		void :ref:`clipDisable<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1ab78ce1cd8ee217f682fe970d136c0f42>`();
		void :ref:`clipPlaneEnable<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a390537b56ca7e1411ebb5faf0c8b3980>`(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& x, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& y, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Width, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Height);
		void :ref:`clipPlaneDisable<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a547ebc217438b9c82fd460f38e99c01f>`();
		std::size_t :target:`getMaskCount<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a2a45696f1b28725c72b17fbe8eebede8>`() const;
		const :ref:`Drawable<doxid-class_e_e_1_1_graphics_1_1_drawable>`*& :target:`operator[]<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a919c22656eaa06a5681918c2ba140cd6>`(std::size_t index);
		const :ref:`Drawable<doxid-class_e_e_1_1_graphics_1_1_drawable>`*const& :target:`operator[]<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a13a39f76d9d5e70925f2a11611259763>`(std::size_t index) const;
		void :target:`clearMasks<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a035198abf9a3dd61bcf952bc1e637f3e>`();
		void :target:`appendMask<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1aaf141c7c4ac054e15c9ec23fbb422887>`(const :ref:`Drawable<doxid-class_e_e_1_1_graphics_1_1_drawable>`& drawable);
		void :target:`removeMask<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1ad571c1e3a45a3b1619bd9e3c1f36fd0b>`(const :ref:`Drawable<doxid-class_e_e_1_1_graphics_1_1_drawable>`& drawable);
		:ref:`Mode<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a32a4a593e1b94c3c66dc6b9c5b7d5188>` :target:`getMaskMode<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1ad58ae917e4705c615072008c09df18e1>`() const;
		void :target:`setMaskMode<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1ae851f01148c6db57da940072b503cd9c>`(:ref:`Mode<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a32a4a593e1b94c3c66dc6b9c5b7d5188>` theMode);
		void :target:`stencilMaskEnable<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a2c220fd6cbae954adb5d613783cdf7bd>`();
		void :target:`stencilMaskDisable<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a8cc108f1dcc545e15c94b8a8774fd364>`(bool clearMasks = false);
		const std::vector<:ref:`Rectf<doxid-namespace_e_e_1_1_math_1aefd467ee6062a2c42afecab58ad12c32>`>& :target:`getScissorsClipped<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a4c4d9b2f0c1f314f2462c1b2b284c064>`() const;
		void :target:`setScissorsClipped<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a6cb4715e72c8cbdb18e2f7352c55516c>`(const std::vector<:ref:`Rectf<doxid-namespace_e_e_1_1_math_1aefd467ee6062a2c42afecab58ad12c32>`>& scissorsClipped);
		const std::vector<:ref:`Rectf<doxid-namespace_e_e_1_1_math_1aefd467ee6062a2c42afecab58ad12c32>`>& :target:`getPlanesClipped<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a33c68c1ceec53697a01c40f21d1e245d>`() const;
		void :target:`setPlanesClipped<doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a7fa2b36dc03af1b7095464213848f1f9>`(const std::vector<:ref:`Rectf<doxid-namespace_e_e_1_1_math_1aefd467ee6062a2c42afecab58ad12c32>`>& planesClipped);
	};
.. _details-class_e_e_1_1_graphics_1_1_clipping_mask:

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



Methods
-------

.. index:: pair: function; clipEnable
.. _doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1adedbe111ec1b7ba73265574b5c6338ad:

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

	void clipEnable(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& x, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& y, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Width, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Height)

Set the current Clipping area ( default the entire window, SCISSOR TEST ).

.. index:: pair: function; clipDisable
.. _doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1ab78ce1cd8ee217f682fe970d136c0f42:

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

	void clipDisable()

Disable the Clipping area

.. index:: pair: function; clipPlaneEnable
.. _doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a390537b56ca7e1411ebb5faf0c8b3980:

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

	void clipPlaneEnable(const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& x, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& y, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Width, const :ref:`Int32<doxid-namespace_e_e_1a8799799f12a84296a0119322c99c6c17>`& Height)

Clip the area with a plane.

.. index:: pair: function; clipPlaneDisable
.. _doxid-class_e_e_1_1_graphics_1_1_clipping_mask_1a547ebc217438b9c82fd460f38e99c01f:

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

	void clipPlaneDisable()

Disable the clip plane area.