/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
#ifndef HEADLESS
#include <jlong.h>
#include <string.h>
#include "sun_java2d_SunGraphics2D.h"
#include "sun_java2d_pipe_BufferedPaints.h"
#include "OGLPaints.h"
#include "OGLContext.h"
#include "OGLRenderQueue.h"
#include "OGLSurfaceData.h"
void
{
// switch to texture unit 1, where paint state is currently enabled
}
switch (oglc->paintState) {
break;
// Note: The texture object used in SetTexturePaint() will
// still be bound at this point, so it is safe to call the following.
break;
break;
default:
break;
}
// restore control to texture unit 0
}
// set each component of the current color state to the extra alpha
// value, which will effectively apply the extra alpha to each fragment
}
void
{
jubyte r, g, b, a;
// glColor*() is allowed within glBegin()/glEnd() pairs, so
// no need to reset the current op state here unless the paint
// state really needs to be changed
}
// store the raw (unmodified) pixel value, which may be used for
// special operations later
" updating color: r=%02x g=%02x b=%02x a=%02x",
r, g, b, a);
} else {
a = 0xff;
" updating xor color: r=%02x g=%02x b=%02x xorpixel=%08x",
}
j2d_glColor4ub(r, g, b, a);
oglc->r = r;
oglc->g = g;
oglc->b = b;
oglc->a = a;
}
/************************* GradientPaint support ****************************/
static void
{
GL_RGBA8, 2, 0,
}
void
{
if (useMask) {
// set up the paint on texture unit 1 (instead of the usual unit 0)
} else {
// texture unit 0 is already active; we can use the helper macro here
}
if (gradientTexID == 0) {
}
if (useMask) {
// restore control to texture unit 0
}
// oglc->pixel has been set appropriately in OGLPaints_ResetPaint()
}
/************************** TexturePaint support ****************************/
void
{
/*
* Note that we explicitly use GL_TEXTURE_2D below rather than using
* srcOps->textureTarget. This is because the texture wrap mode employed
* here (GL_REPEAT) is not available for GL_TEXTURE_RECTANGLE_ARB targets.
* The setup code in OGLPaints.Texture.isPaintValid() and in
* OGLSurfaceData.initTexture() ensures that we only get here for
* GL_TEXTURE_2D targets.
*/
if (useMask) {
// set up the paint on texture unit 1 (instead of the usual unit 0)
} else {
// texture unit 0 is already active; we can use the helper macro here
}
if (useMask) {
// restore control to texture unit 0
}
// oglc->pixel has been set appropriately in OGLPaints_ResetPaint()
}
/****************** Shared MultipleGradientPaint support ********************/
/**
* These constants are identical to those defined in the
* MultipleGradientPaint.CycleMethod enum; they are copied here for
* convenience (ideally we would pull them directly from the Java level,
* but that entails more hassle than it is worth).
*/
#define CYCLE_NONE 0
/**
* The following constants are flags that can be bitwise-or'ed together
* to control how the MultipleGradientPaint shader source code is generated:
*
* MULTI_CYCLE_METHOD
* Placeholder for the CycleMethod enum constant.
*
* MULTI_LARGE
* If set, use the (slower) shader that supports a larger number of
* gradient colors; otherwise, use the optimized codepath. See
* the MAX_FRACTIONS_SMALL/LARGE constants below for more details.
*
* MULTI_USE_MASK
* If set, apply the alpha mask value from texture unit 0 to the
* final color result (only used in the MaskFill case).
*
* MULTI_LINEAR_RGB
* If set, convert the linear RGB result back into the sRGB color space.
*/
/**
* This value determines the size of the array of programs for each
* MultipleGradientPaint type. This value reflects the maximum value that
* can be represented by performing a bitwise-or of all the MULTI_*
* constants defined above.
*/
/** Evaluates to true if the given bit is set on the local flags variable. */
/** Composes the given parameters as flags into the given flags variable.*/
do { \
} while (0)
/** Extracts the CycleMethod enum value from the given flags variable. */
((flags) & MULTI_CYCLE_METHOD)
/**
* The maximum number of gradient "stops" supported by the fragment shader
* and related code. When the MULTI_LARGE flag is set, we will use
* MAX_FRACTIONS_LARGE; otherwise, we use MAX_FRACTIONS_SMALL. By having
* two separate values, we can have one highly optimized shader (SMALL) that
* shader that supports more stops.
*/
/**
* The maximum number of gradient colors supported by all of the gradient
* fragment shaders. Note that this value must be a power of two, as it
* determines the size of the 1D texture created below. It also must be
* greater than or equal to MAX_FRACTIONS (there is no strict requirement
* that the two values be equal).
*/
/**
* The handle to the gradient color table texture object used by the shaders.
*/
/**
* This is essentially a template of the shader source code that can be used
* for either LinearGradientPaint or RadialGradientPaint. It includes the
* structure and some variables that are common to each; the remaining
* code snippets (for CycleMethod, ColorSpaceType, and mask modulation)
* are filled in prior to compiling the shader at runtime depending on the
* paint parameters. See OGLPaints_CreateMultiGradProgram() for more details.
*/
static const char *multiGradientShaderSource =
// gradient texture size (in texels)
"const int TEXTURE_SIZE = %d;"
"const int MAX_FRACTIONS = %d;"
// size of a single texel
"const float FULL_TEXEL = (1.0 / float(TEXTURE_SIZE));"
// size of half of a single texel
"const float HALF_TEXEL = (FULL_TEXEL / 2.0);"
// texture containing the gradient colors
"uniform sampler1D colors;"
"uniform float fractions[MAX_FRACTIONS];"
// array of scale factors (one for each interval)
"uniform float scaleFactors[MAX_FRACTIONS-1];"
// (placeholder for mask variable)
"%s"
// (placeholder for Linear/RadialGP-specific variables)
"%s"
""
"void main(void)"
"{"
" float dist;"
// (placeholder for Linear/RadialGradientPaint-specific code)
" %s"
""
" float tc;"
// (placeholder for CycleMethod-specific code)
" %s"
""
// calculate interpolated color
" vec4 result = texture1D(colors, tc);"
""
// (placeholder for ColorSpace conversion code)
" %s"
""
// (placeholder for mask modulation code)
" %s"
""
// modulate with gl_Color in order to apply extra alpha
" gl_FragColor = result * gl_Color;"
"}";
/**
* This code takes a "dist" value as input (as calculated earlier by the
* LGP/RGP-specific code) in the range [0,1] and produces a texture
* coordinate value "tc" that represents the position of the chosen color
* in the one-dimensional gradient texture (also in the range [0,1]).
*
* One naive way to implement this would be to iterate through the fractions
* to figure out in which interval "dist" falls, and then compute the
* relative distance between the two nearest stops. This approach would
* require an "if" check on every iteration, and it is best to avoid
* conditionals in fragment shaders for performance reasons. Also, one might
* be tempted to use a break statement to jump out of the loop once the
* interval was found, but break statements (and non-constant loop bounds)
* are not natively available on most graphics hardware today, so that is
* a non-starter.
*
* The more optimal approach used here avoids these issues entirely by using
* an accumulation function that is equivalent to the process described above.
* The scaleFactors array is pre-initialized at enable time as follows:
* scaleFactors[i] = 1.0 / (fractions[i+1] - fractions[i]);
*
* For each iteration, we subtract fractions[i] from dist and then multiply
* that value by scaleFactors[i]. If we are within the target interval,
* this value will be a fraction in the range [0,1] indicating the relative
* distance between fraction[i] and fraction[i+1]. If we are below the
* target interval, this value will be negative, so we clamp it to zero
* to avoid accumulating any value. If we are above the target interval,
* the value will be greater than one, so we clamp it to one. Upon exiting
* the loop, we will have accumulated zero or more 1.0's and a single
* fractional value. This accumulated value tells us the position of the
* fragment color in the one-dimensional gradient texture, i.e., the
* texcoord called "tc".
*/
static const char *texCoordCalcCode =
"int i;"
"float relFraction = 0.0;"
"for (i = 0; i < MAX_FRACTIONS-1; i++) {"
" relFraction +="
" clamp((dist - fractions[i]) * scaleFactors[i], 0.0, 1.0);"
"}"
// we offset by half a texel so that we find the linearly interpolated
// color between the two texel centers of interest
"tc = HALF_TEXEL + (FULL_TEXEL * relFraction);";
/** Code for NO_CYCLE that gets plugged into the CycleMethod placeholder. */
static const char *noCycleCode =
"if (dist <= 0.0) {"
" tc = 0.0;"
"} else if (dist >= 1.0) {"
" tc = 1.0;"
"} else {"
// (placeholder for texcoord calculation)
" %s"
"}";
/** Code for REFLECT that gets plugged into the CycleMethod placeholder. */
static const char *reflectCode =
"dist = 1.0 - (abs(fract(dist * 0.5) - 0.5) * 2.0);"
// (placeholder for texcoord calculation)
"%s";
/** Code for REPEAT that gets plugged into the CycleMethod placeholder. */
static const char *repeatCode =
"dist = fract(dist);"
// (placeholder for texcoord calculation)
"%s";
static void
{
GL_RGBA8, MAX_COLORS, 0,
}
/**
* Compiles and links the MultipleGradientPaint shader program. If
* successful, this function returns a handle to the newly created
* shader program; otherwise returns 0.
*/
static GLhandleARB
{
if (IS_SET(MULTI_USE_MASK)) {
/*
* This code modulates the calculated result color with the
* corresponding alpha value from the alpha mask texture active
* on texture unit 0. Only needed when useMask is true (i.e., only
* for MaskFill operations).
*/
maskVars = "uniform sampler2D mask;";
maskCode = "result *= texture2D(mask, gl_TexCoord[0].st);";
} else {
/*
* REMIND: This is really wacky, but the gradient shaders will
* produce completely incorrect results on ATI hardware (at least
* on first-gen (R300-based) boards) if the shader program does not
* try to access texture coordinates by using a gl_TexCoord[*]
* variable. This problem really should be addressed by ATI, but
* in the meantime it seems we can workaround the issue by inserting
* a benign operation that accesses gl_TexCoord[0]. Note that we
* only need to do this for ATI boards and only in the !useMask case,
* because the useMask case already does access gl_TexCoord[1] and
* is therefore not affected by this driver bug.
*/
maskCode = "dist = gl_TexCoord[0].s;";
}
}
if (IS_SET(MULTI_LINEAR_RGB)) {
/*
* This code converts a single pixel in linear RGB space back
* into sRGB (note: this code was adapted from the
* MultipleGradientPaintContext.convertLinearRGBtoSRGB() method).
*/
"result.rgb = 1.055 * pow(result.rgb, vec3(0.416667)) - 0.055;";
}
if (cycleMethod == CYCLE_NONE) {
} else if (cycleMethod == CYCLE_REFLECT) {
} else { // (cycleMethod == CYCLE_REPEAT)
}
// compose the final source code string from the various pieces
if (multiGradProgram == 0) {
"OGLPaints_CreateMultiGradProgram: error creating program");
return 0;
}
// "use" the program object temporarily so that we can set the uniforms
// set the "uniform" texture unit bindings
if (IS_SET(MULTI_USE_MASK)) {
} else {
}
// "unuse" the program object; it will be re-bound later as needed
if (multiGradientTexID == 0) {
}
return multiGradProgram;
}
/**
* Called from the OGLPaints_SetLinear/RadialGradientPaint() methods
*/
static void
void *pFractions, void *pPixels)
{
int i;
// enable the MultipleGradientPaint shader
// update the "uniform" fraction values
if (numStops < maxFractions) {
// fill the remainder of the fractions array with all zeros to
// prevent using garbage values from previous paints
}
// update the "uniform" scale values
for (i = 0; i < numStops-1; i++) {
// calculate a scale factor for each interval
}
for (; i < maxFractions-1; i++) {
// fill remaining scale factors with zero
scaleFactors[i] = 0.0f;
}
// update the texture containing the gradient colors
0, numStops,
pixels);
if (numStops < MAX_COLORS) {
// when we don't have enough colors to fill the entire color gradient,
// we have to replicate the last color in the right-most texel for
// the NO_CYCLE case where the texcoord is sometimes forced to 1.0
}
}
/********************** LinearGradientPaint support *************************/
/**
* The handles to the LinearGradientPaint fragment program objects. The
* index to the array should be a bitwise-or'ing of the MULTI_* flags defined
* above. Note that most applications will likely need to initialize one
* or two of these elements, so the array is usually sparsely populated.
*/
/**
* Compiles and links the LinearGradientPaint shader program. If successful,
* this function returns a handle to the newly created shader program;
* otherwise returns 0.
*/
static GLhandleARB
{
char *paintVars;
char *distCode;
"OGLPaints_CreateLinearGradProgram",
flags);
/*
* To simplify the code and to make it easier to upload a number of
* uniform values at once, we pack a bunch of scalar (float) values
* into vec3 values below. Here's how the values are related:
*
* params.x = p0
* params.y = p1
* params.z = p3
*
* yoff = dstOps->yOffset + dstOps->height
*/
"uniform vec3 params;"
"uniform float yoff;";
distCode =
// note that gl_FragCoord is in window space relative to the
// lower-left corner, so we have to flip the y-coordinate here
"vec3 fragCoord = vec3(gl_FragCoord.x, yoff-gl_FragCoord.y, 1.0);"
"dist = dot(params, fragCoord);";
}
void
{
if (useMask) {
// set up the paint on texture unit 1 (instead of the usual unit 0)
}
// no need to set GL_MODULATE here (it is ignored when shader is enabled)
// locate/initialize the shader program for the given flags
if (linearGradPrograms[flags] == 0) {
if (linearGradPrograms[flags] == 0) {
// shouldn't happen, but just in case...
return;
}
}
// update the common "uniform" values (fractions and colors)
// update the other "uniform" values
if (useMask) {
// restore control to texture unit 0
}
// oglc->pixel has been set appropriately in OGLPaints_ResetPaint()
}
/********************** RadialGradientPaint support *************************/
/**
* The handles to the RadialGradientPaint fragment program objects. The
* index to the array should be a bitwise-or'ing of the MULTI_* flags defined
* above. Note that most applications will likely need to initialize one
* or two of these elements, so the array is usually sparsely populated.
*/
/**
* Compiles and links the RadialGradientPaint shader program. If successful,
* this function returns a handle to the newly created shader program;
* otherwise returns 0.
*/
static GLhandleARB
{
char *paintVars;
char *distCode;
"OGLPaints_CreateRadialGradProgram",
flags);
/*
* To simplify the code and to make it easier to upload a number of
* uniform values at once, we pack a bunch of scalar (float) values
* into vec3 and vec4 values below. Here's how the values are related:
*
* m0.x = m00
* m0.y = m01
* m0.z = m02
*
* m1.x = m10
* m1.y = m11
* m1.z = m12
*
* precalc.x = focusX
* precalc.y = yoff = dstOps->yOffset + dstOps->height
* precalc.z = 1.0 - (focusX * focusX)
* precalc.w = 1.0 / precalc.z
*/
"uniform vec3 m0;"
"uniform vec3 m1;"
"uniform vec4 precalc;";
/*
* The following code is derived from Daniel Rice's whitepaper on
* radial gradient performance (attached to the bug report for 6521533).
* Refer to that document as well as the setup code in the Java-level
* BufferedPaints.setRadialGradientPaint() method for more details.
*/
distCode =
// note that gl_FragCoord is in window space relative to the
// lower-left corner, so we have to flip the y-coordinate here
"vec3 fragCoord ="
" vec3(gl_FragCoord.x, precalc.y - gl_FragCoord.y, 1.0);"
"float x = dot(fragCoord, m0);"
"float y = dot(fragCoord, m1);"
"float xfx = x - precalc.x;"
"dist = (precalc.x*xfx + sqrt(xfx*xfx + y*y*precalc.z))*precalc.w;";
}
void
{
if (useMask) {
// set up the paint on texture unit 1 (instead of the usual unit 0)
}
// no need to set GL_MODULATE here (it is ignored when shader is enabled)
// locate/initialize the shader program for the given flags
if (radialGradPrograms[flags] == 0) {
if (radialGradPrograms[flags] == 0) {
// shouldn't happen, but just in case...
return;
}
}
// update the common "uniform" values (fractions and colors)
// update the other "uniform" values
// pack a few unrelated, precalculated values into a single vec4
if (useMask) {
// restore control to texture unit 0
}
// oglc->pixel has been set appropriately in OGLPaints_ResetPaint()
}
#endif /* !HEADLESS */