Differential D9848 Diff 25720 effects/blur/blurshader.h

Changeset View

Standalone View

effects/blur/blurshader.h

1	/*	1		/*
2	* Copyright © 2010 Fredrik Höglund <fredrik@kde.org>	2		* Copyright © 2010 Fredrik Höglund <fredrik@kde.org>
		3		* Copyright © 2018 Alex Nemeth <alex.nemeth329@gmail.com>
3	*	4		*
4	* This program is free software; you can redistribute it and/or modify	5		* This program is free software; you can redistribute it and/or modify
5	* it under the terms of the GNU General Public License as published by	6		* it under the terms of the GNU General Public License as published by
6	* the Free Software Foundation; either version 2 of the License, or	7		* the Free Software Foundation; either version 2 of the License, or
7	* (at your option) any later version.	8		* (at your option) any later version.
8	*	9		*
9	* This program is distributed in the hope that it will be useful,	10		* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of	11		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU	12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12	* General Public License for more details.	13		* General Public License for more details.
13	*	14		*
14	* You should have received a copy of the GNU General Public License	15		* You should have received a copy of the GNU General Public License
15	* along with this program; see the file COPYING. if not, write to	16		* along with this program; see the file COPYING. if not, write to
16	* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,	17		* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17	* Boston, MA 02110-1301, USA.	18		* Boston, MA 02110-1301, USA.
18	*/	19		*/
19		20
20	#ifndef BLURSHADER_H	21		#ifndef BLURSHADER_H
21	#define BLURSHADER_H	22		#define BLURSHADER_H
22		23
23	#include <kwinglutils.h>	24		#include <kwinglutils.h>
		25		#include <QVector2D>
		26		#include <QVector4D>
		27
24		28
25	class QMatrix4x4;	29		class QMatrix4x4;
26		30
27	namespace KWin	31		namespace KWin
28	{	32		{
29		33
30	struct KernelValue
31	{
32	KernelValue() {}
33	KernelValue(float x, float g) : x(x), g(g) {}
34	bool operator < (const KernelValue &other) const { return x < other.x; }
35
36	float x;
37	float g;
38	};
39
40	class BlurShader	34		class BlurShader
41	{	35		{
42	public:	36		public:
43	BlurShader();	37		BlurShader();
44	virtual ~BlurShader();	38		virtual ~BlurShader();
45		39
46	static BlurShader *create();	40		static BlurShader *create();
47		41
48	bool isValid() const {	42		bool isValid() const {
49	return mValid;	43		return mValid;
50	}	44		}
51		45
52	// Sets the radius in pixels
53	void setRadius(int radius);
54	int radius() const {
55	return mRadius;
56	}
57
58	// Sets the blur direction
59	void setDirection(Qt::Orientation direction);
60	Qt::Orientation direction() const {
61	return mDirection;
62	}
63
64	// Sets the distance between two pixels
65	virtual void setPixelDistance(float val) = 0;
66	virtual void setTextureMatrix(const QMatrix4x4 &matrix) = 0;
67	virtual void setModelViewProjectionMatrix(const QMatrix4x4 &matrix) = 0;	46		virtual void setModelViewProjectionMatrix(const QMatrix4x4 &matrix) = 0;
		47		virtual void setOffset(float offset) = 0;
		48		virtual void setTargetSize(QSize renderTextureSize) = 0;
			fredrikUnsubmitted Done I suggest changing the name to setTargetSize() to make it clear that the size is the size of the render target, and not the size of the texture being sampled. fredrik: I suggest changing the name to setTargetSize() to make it clear that the size is the size of…
		49		virtual void setBlurRect(QRect blurRect, QSize screenSize) = 0;
		50
		51		enum SampleType {
		52		DownSampleType,
		53		UpSampleType,
		54		CopySampleType
		55		};
68		56
69	virtual void bind() = 0;	57		virtual void bind(SampleType sampleType) = 0;
			fredrikUnsubmitted Done sampleTypeEnum sampleType fredrik: sampleTypeEnum sampleType
70	virtual void unbind() = 0;	58		virtual void unbind() = 0;
71		59
72	protected:	60		protected:
			fredrikUnsubmitted Done The first letter in enums should be capitalized. I think SampleType would also be a better name. fredrik: The first letter in enums should be capitalized. I think SampleType would also be a better name.
			fredrikUnsubmitted Done The first letters in the enumerators should also be capitalized. fredrik: The first letters in the enumerators should also be capitalized.
73	float gaussian(float x, float sigma) const;
74	QList<KernelValue> gaussianKernel() const;
75	void setIsValid(bool value) {	61		void setIsValid(bool value) {
76	mValid = value;	62		mValid = value;
77	}	63		}
78	virtual void init() = 0;	64		virtual void init() = 0;
79	virtual void reset() = 0;	65		virtual void reset() = 0;
80	virtual int maxKernelSize() const = 0;
81		66
82	private:	67		private:
83	int mRadius;
84	Qt::Orientation mDirection;
85	bool mValid;	68		bool mValid;
86	};	69		};
87		70
88		71
89	// ----------------------------------------------------------------------------	72		// ----------------------------------------------------------------------------
90		73
91		74
92		75
93	class GLSLBlurShader : public BlurShader	76		class GLSLBlurShader : public BlurShader
94	{	77		{
95	public:	78		public:
96	GLSLBlurShader();	79		GLSLBlurShader();
97	~GLSLBlurShader();	80		~GLSLBlurShader();
98		81
99	void setPixelDistance(float val);	82		void bind(SampleType sampleType) override final;
100	void bind();	83		void unbind() override final;
			fredrikUnsubmitted Done override final This goes for all reimplemented virtual functions. fredrik: override final This goes for all reimplemented virtual functions.
101	void unbind();	84		void setModelViewProjectionMatrix(const QMatrix4x4 &matrix) override final;
102	void setTextureMatrix(const QMatrix4x4 &matrix);	85		void setOffset(float offset) override final;
103	void setModelViewProjectionMatrix(const QMatrix4x4 &matrix);	86		void setTargetSize(QSize renderTextureSize) override final;
		87		void setBlurRect(QRect blurRect, QSize screenSize) override final;
104		88
105	protected:	89		protected:
106	void init();	90		void init() override final;
107	void reset();	91		void reset() override final;
108	int maxKernelSize() const;
109		92
110	private:	93		private:
111	GLShader *shader;	94		GLShader *m_shaderDownsample = nullptr;
112	int mvpMatrixLocation;	95		GLShader *m_shaderUpsample = nullptr;
113	int textureMatrixLocation;	96		GLShader *m_shaderCopysample = nullptr;
			fredrikUnsubmitted Not Done I think you could simplify the code quite a bit by having an array of struct { GLShader shader; int mvpMatrixLocation; ... }; and use m_activeSampleType as an index into that array. fredrik:* I think you could simplify the code quite a bit by having an array of ``` struct { GLShader…
			anemethAuthorUnsubmitted Not Done Only the downsample and upsample have the same uniforms, copysample uses different ones. This means that it would be an array with only 2 elements (up and down sample). I think it's unnecessary to create an array with only 2 elements. anemeth: Only the downsample and upsample have the same uniforms, copysample uses different ones. This…
114	int pixelSizeLocation;	97
		98		int m_mvpMatrixLocationDownsample;
		99		int m_offsetLocationDownsample;
		100		int m_renderTextureSizeLocationDownsample;
		101		int m_halfpixelLocationDownsample;
		102
		103		int m_mvpMatrixLocationUpsample;
		104		int m_offsetLocationUpsample;
		105		int m_renderTextureSizeLocationUpsample;
		106		int m_halfpixelLocationUpsample;
		107
		108		int m_mvpMatrixLocationCopysample;
			zzagUnsubmitted Done Coding style + consistency: GLShader m_shaderDownsample; GLShader m_shaderUpsample; GLShader m_shaderCopysample; int m_mvpMatrixLocationDownsample; int m_offsetLocationDownsample; int m_textureSizeLocationDownsample; int m_mvpMatrixLocationUpsample; int m_offsetLocationUpsample; int m_textureSizeLocationUpsample; int m_mvpMatrixLocationCopysample; int m_textureSizeLocationCopysample; int m_blurRectLocationCopysample; zzag:* Coding style + consistency: ``` GLShader *m_shaderDownsample; GLShader…
		109		int m_renderTextureSizeLocationCopysample;
		110		int m_blurRectLocationCopysample;
		111
		112
			zzagUnsubmitted Done `m_` zzag: `m_`
		113		//Caching uniform values to aviod unnecessary setUniform calls
		114		int m_activeSampleType;
		115
		116		float m_offsetDownsample;
		117		QMatrix4x4 m_matrixDownsample;
		118		QSize m_renderTextureSizeDownsample;
		119
		120		float m_offsetUpsample;
		121		QMatrix4x4 m_matrixUpsample;
		122		QSize m_renderTextureSizeUpsample;
		123
		124		QMatrix4x4 m_matrixCopysample;
		125		QSize m_renderTextureSizeCopysample;
		126		QRect m_blurRectCopysample;
		127
115	};	128		};
116		129
117	} // namespace KWin	130		} // namespace KWin
118		131
119	#endif	132		#endif
120