Spinning Topp Logo BlackTopp Studios
inc
alphamodifier.cpp
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine 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  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 /*
41  -----------------------------------------------------------------------------
42  This source file is part of ogre-procedural
43 
44  For the latest info, see http://code.google.com/p/ogre-procedural/
45 
46  Copyright (c) 2010-2013 Michael Broutin
47 
48  Permission is hereby granted, free of charge, to any person obtaining a copy
49  of this software and associated documentation files (the "Software"), to deal
50  in the Software without restriction, including without limitation the rights
51  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
52  copies of the Software, and to permit persons to whom the Software is
53  furnished to do so, subject to the following conditions:
54 
55  The above copyright notice and this permission notice shall be included in
56  all copies or substantial portions of the Software.
57 
58  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
59  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
60  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
61  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
62  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
63  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
64  THE SOFTWARE.
65  -----------------------------------------------------------------------------
66  */
67 #ifndef _graphicsproceduralalphamodifier_cpp
68 #define _graphicsproceduralalphamodifier_cpp
69 
70 #include "Graphics/Procedural/Texture/alphamodifier.h"
71 
72 namespace Mezzanine
73 {
74  namespace Graphics
75  {
76  namespace Procedural
77  {
79  ExtractColour(1.0,1.0,1.0,1.0)
80  { }
81 
83  { }
84 
85  ///////////////////////////////////////////////////////////////////////////////
86  // Utility
87 
89  {
90  Whole Width = Buffer.GetWidth();
91  Whole Height = Buffer.GetHeight();
92 
93  for( Whole Y = 0 ; Y < Height ; ++Y )
94  {
95  for( Whole X = 0 ; X < Width ; ++X )
96  {
97  Real Red = static_cast<Real>( Buffer.GetRedByte(X,Y) ) * this->ExtractColour.RedChannel;
98  Real Green = static_cast<Real>( Buffer.GetGreenByte(X,Y) ) * this->ExtractColour.GreenChannel;
99  Real Blue = static_cast<Real>( Buffer.GetBlueByte(X,Y) ) * this->ExtractColour.BlueChannel;
100  UInt8 Alpha = static_cast<UInt8>( ( static_cast<Whole>( Buffer.GetAlphaByte(X,Y) ) + static_cast<Whole>(Red + Green + Blue) ) >> 1 );
101  Buffer.SetPixelByte(X,Y,Alpha,Alpha,Alpha,Alpha);
102  }
103  }
104  }
105 
107  { return "AlphaModifier"; }
108 
109  ///////////////////////////////////////////////////////////////////////////////
110  // Configuration
111 
113  { this->ExtractColour = Extract; return *this; }
114  }//Procedural
115  }//Graphics
116 }//Mezzanine
117 
118 #endif
virtual void Modify(TextureBuffer &Buffer)
Alters the generated pixels in a TextureBuffer.
void SetPixelByte(const Whole X, const Whole Y, const ColourChannelType Red, const ColourChannelType Green, const ColourChannelType Blue, const ColourChannelType Alpha=255)
Set colour of a specified pixel using a 0-255 range. the X or Y location go beyond the set size of th...
A modifier that will replace all pixels with "White Smoke" corresponding to the intensity of the extr...
Definition: alphamodifier.h:83
Whole GetWidth() const
Get the pixel width of this texture.
ColourChannelType GetBlueByte(const Whole X, const Whole Y) const
Gets the blue colour value of a specified pixel. the X or Y location go beyond the set size of this t...
uint8_t UInt8
An 8-bit unsigned integer.
Definition: datatypes.h:118
This is a simple class for holding 4 reals representing the colour any give object or lightsource can...
Definition: colourvalue.h:64
ColourChannelType GetAlphaByte(const Whole X, const Whole Y) const
Gets the alpha colour value of a specified pixel. the X or Y location go beyond the set size of this ...
float Real
A Datatype used to represent a real floating point number.
Definition: datatypes.h:141
Real GreenChannel
Value from 0.0 to 1.0 representing the amount of green present in the colour. 1.0 if very green...
Definition: colourvalue.h:73
A convenience buffer that stores pixel colour values of a texture to be generated.
Definition: texturebuffer.h:86
AlphaModifier & SetExtractColour(const ColourValue &Extract)
Sets the amount of colour to extract for each colour channel.
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56
unsigned long Whole
Whole is an unsigned integer, it will be at least 32bits in size.
Definition: datatypes.h:151
Whole GetHeight() const
Get the pixel height of this texture.
Real BlueChannel
Value from 0.0 to 1.0 representing the amount of blue present in the colour. 1.0 if very blue...
Definition: colourvalue.h:76
Real RedChannel
Value from 0.0 to 1.0 representing the amount of red present in the colour. 1.0 if very red...
Definition: colourvalue.h:70
ColourChannelType GetGreenByte(const Whole X, const Whole Y) const
Gets the green colour value of a specified pixel. the X or Y location go beyond the set size of this ...
ColourValue ExtractColour
The amount from each colour channel to be extracted from the source texture.
Definition: alphamodifier.h:88
std::string String
A datatype used to a series of characters.
Definition: datatypes.h:159
ColourChannelType GetRedByte(const Whole X, const Whole Y) const
Gets the red colour value of a specified pixel. the X or Y location go beyond the set size of this te...
virtual String GetName() const
Gets the name of this modifier.