6502/CLK
1
0
Fork 0
mirror of https://github.com/TomHarte/CLK.git synced 2024-07-06 01:28:57 +00:00
Code Issues Projects Releases Wiki Activity

Updated documentation, taking the opportunity to improve a parameter name.

Browse Source
This commit is contained in:
Thomas Harte 2016-04-27 22:57:40 -04:00
parent 7c20fce467
commit 494ef6a324
2 changed files with 24 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Outputs/CRT/Internals/Shaders/OutputShader.cpp
View File

@ -23,7 +23,7 @@ namespace {
};
}
std::unique_ptr<OutputShader> OutputShader::make_shader(const char *fragment_methods, const char *output_colour, bool use_usampler)
std::unique_ptr<OutputShader> OutputShader::make_shader(const char *fragment_methods, const char *colour_expression, bool use_usampler)
{
const char *sampler_type = use_usampler ? "usampler2D" : "sampler2D";

39
Outputs/CRT/Internals/Shaders/OutputShader.hpp
View File

@ -21,33 +21,40 @@ public:
Constructs and returns an instance of OutputShader. OutputShaders are intended to read source data
from a texture and draw a single raster scan containing that data as output.
The fragment shader should expect to receive the inputs:
Does not catch any of the exceptions potentially thrown by `Shader::Shader`.
in float lateralVarying;
in vec2 srcCoordinatesVarying;
in vec2 iSrcCoordinatesVarying;
All instances of OutputShader are guaranteed to use the same attribute locations for their inputs.
If `use_usampler` is `true` then a `uniform usampler2D texID` will be used as the source texture.
Otherwise it'll be a `sampler2D`.
@param fragment_methods A block of code that will appear within the global area of the fragment shader.
`lateralVarying` is a value in radians that is equal to 0 at the centre of the scan and ± a suitable
angle at the top and bottom extremes.
@param colour_expression An expression that should evaluate to a `vec3` indicating the colour at the current location. The
decision should be a function of the uniform `texID`, which will be either a `usampler2D` or a `sampler2D` as per the
`use_usampler` parameter, and the inputs `srcCoordinatesVarying` which is a location within the texture from which to
take the source value, and `iSrcCoordinatesVarying` which is a value proportional to `srcCoordinatesVarying` but scaled
so that one unit equals one source sample.
`srcCoordinatesVarying` is a value representing the coordinates for source data in the texture
attached to the sampler `texID`.
`iSrcCoordinatesVarying` is a value corresponding to `srcCoordinatesVarying` but scaled up so that
one unit is the width of one source sample.
Does not catch any exceptions raised by `Shader::Shader`.
@param use_usampler Dictates the type of the `texID` uniform; will be a `usampler2D` if this parameter is `true`, a
`sampler2D` otherwise.
@returns an instance of OutputShader.
*/
static std::unique_ptr<OutputShader> make_shader(const char *fragment_methods, const char *output_colour, bool use_usampler);
static std::unique_ptr<OutputShader> make_shader(const char *fragment_methods, const char *colour_expression, bool use_usampler);
using Shader::Shader;
/*!
Binds this shader and configures it for output to an area of `output_width` and `output_height` pixels, ensuring
the largest possible drawing size that allows everything within `visible_area` to be visible.
*/
void set_output_size(unsigned int output_width, unsigned int output_height, Outputs::CRT::Rect visible_area);
/*!
Binds this shader and sets the texture unit (as an enum, e.g. `GL_TEXTURE0`) to sample as source data.
*/
void set_source_texture_unit(GLenum unit);
/*!
Binds this shader and configures its understanding of how to map from the source vertex stream to screen coordinates.
*/
void set_timing(unsigned int height_of_display, unsigned int cycles_per_line, unsigned int horizontal_scan_period, unsigned int vertical_scan_period, unsigned int vertical_period_divider);
private: