Skip to content

[WIP] Docs: Add initial draft of Strands documentation (feedback wanted) #7940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: dev-2.0
Choose a base branch
from

Conversation

Abhayaj247
Copy link

Note: This PR replaces #7920 to resolve merge conflicts that occurred while rebasing onto the dev-2.0 branch.


This PR introduces new JSDoc reference entries for several p5.strands hooks, as discussed in #7919 and based on recent feedback.

Key updates:

  • Added detailed documentation and JavaScript-only usage examples for the following hooks:
    • getWorldInputs
    • combineColors
    • getPointSize
  • Described callback signatures for each hook.
  • Placed the new doc comments in src/webgl/p5.strands.js for clarity and modularity.

Request for feedback:

  • Please review the documentation style, level of detail, and the chosen file location.
  • If another location is preferred for these comments, I’m happy to move them.

Once I receive feedback and confirmation on the format and placement, I’ll proceed to document the remaining hooks in the same style.

Thank you for your time and guidance!

@Abhayaj247
Copy link
Author

Hi @perminder-17 Could you please review this new PR? It replaces the previous one #7920 due to merge conflicts and now targets dev-2.0.

Thank you!

Copy link
Collaborator

@perminder-17 perminder-17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Abhayaj247, thank you for your work! I noticed you added a new p5.strands.js file under src/webgl just for documentation, but it isn’t referenced anywhere else in the repo. Could you instead place your docs to the end of shaderGenerator.js? That way we avoid adding an unused file and keep things cleaner.

@Abhayaj247
Copy link
Author

Hi @Abhayaj247, thank you for your work! I noticed you added a new p5.strands.js file under src/webgl just for documentation, but it isn’t referenced anywhere else in the repo. Could you instead place your docs to the end of shaderGenerator.js? That way we avoid adding an unused file and keep things cleaner.

Hi @perminder-17,

I’ve moved the p5.strands JSDoc documentation to the end of shaderGenerator.js as requested, starting from line 1644. The separate file has been removed.

Could you please confirm if the style, detail, and placement look good? Once you approve, I’ll proceed to document the remaining hooks in the same format.

Please let me know if you’d like any further adjustments. Thank you!

@Abhayaj247 Abhayaj247 requested a review from perminder-17 June 26, 2025 14:07
* Registers a callback to modify the world-space properties of each vertex in a shader. This hook can be used inside {@link p5.baseMaterialShader}.modify() and similar shader modify calls to customize vertex positions, normals, texture coordinates, and colors before rendering. "World space" refers to the coordinate system of the 3D scene, before any camera or projection transformations are applied.
*
* This hook is available in:
* - {@link p5.baseMaterialShader}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think although this is valid JSDoc, we don't yet support it in p5's jsdoc-to-reference pipeline. Currently we use <a href="...">, e.g.:

* <a href="#/p5/setup">setup()</a> before using the result.

Copy link
Author

@Abhayaj247 Abhayaj247 Jun 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @davepagurek ,
I've updated all references to use the <a href="..."> syntax that p5.js supports, following the pattern from p5.Font.js. All links now use the format <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>.


/* ------------------------------------------------------------- */
/**
* @typedef {Object} Vertex
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm also not sure that typedef docs will show up in the reference, even though this does simplify the writing of the function parameter. If you test your branch on the p5.js-website repo, what does this look like? If it doesn't render, we may need to either document this object inline, or update the website to be able to support this syntax.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davepagurek Thank you for the guidance on the @typedef issue. I've removed it and documented the vertex object properties inline in the parameter description to ensure clarity and compatibility with the documentation pipeline.

* @param {function(ColorComponents): { color: {r: number, g: number, b: number}, opacity: number }} callback
* A callback function which receives a ColorComponents struct and returns the final color and opacity.
*
* @see {@link p5.baseMaterialShader}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to above, we probably don't support @see yet, but feel free to use regular links in a paragraph explaining why you might want to check out these related references!

Copy link
Author

@Abhayaj247 Abhayaj247 Jun 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davepagurek , I've removed all @see tags since they're not supported in the current documentation pipeline. The documentation now relies on clear descriptions and contextual examples to guide users to related references.

* myShader = baseMaterialShader().modify(() => {
* combineColors(components => {
* // Custom color combination: add a red tint
* let color = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although you can access .r, .g, .b, and .a properties, the return value would need to be either [r, g, b, a] as an array, or more explicitly, vec4(r, g, b, a) -- we don't yet support an object notation for this. (Also it will need to be just the one object, and not an object with separate color and opacity properties, for it to compile correctly I think.)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This also makes me wonder what the best way to document the inputs object is, since it's not exactly any normal type. @lukeplowden do you have any thoughts on this? We could call it a vec4 and then explain in the description of the function what this means, or even not give it a type at all, and just have an explanation in the description.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although you can access .r, .g, .b, and .a properties, the return value would need to be either [r, g, b, a] as an array, or more explicitly, vec4(r, g, b, a) -- we don't yet support an object notation for this. (Also it will need to be just the one object, and not an object with separate color and opacity properties, for it to compile correctly I think.)

@davepagurek , I've corrected the combineColors example to return vec4(r, g, b, a) instead of object notation. The example now properly demonstrates the correct return format that will compile successfully.

This also makes me wonder what the best way to document the inputs object is, since it's not exactly any normal type. @lukeplowden do you have any thoughts on this? We could call it a vec4 and then explain in the description of the function what this means, or even not give it a type at all, and just have an explanation in the description.

Excellent point about the input object documentation. I've updated the parameter descriptions to clearly specify the available properties without using complex type annotations. For getWorldInputs, I've documented the vertex object properties inline, and for combineColors, I've listed all available color component properties in the description.

@Abhayaj247
Copy link
Author

Abhayaj247 commented Jun 29, 2025

Thank you for the comprehensive feedback @davepagurek . I've addressed all the documentation compatibility issues:

  • Updated all links to use the supported <a href="..."> syntax
  • Removed @typedef and documented properties inline
  • Removed unsupported @see tags
  • Corrected the combineColors return format to use vec4(r, g, b, a)
  • Improved parameter documentation with clear property descriptions

The documentation should now be fully compatible with the current p5.js documentation pipeline.

If there are any other modifications or improvements you’d like to see, please let me know—I'm happy to make further adjustments as needed.

@Abhayaj247 Abhayaj247 requested a review from davepagurek June 29, 2025 09:14
@@ -1700,19 +1689,16 @@ if (typeof p5 !== 'undefined') {
* @function combineColors
* @experimental
* @description
* Registers a callback to customize how color components are combined in the fragment shader. This hook can be used inside {@link p5.baseMaterialShader}.modify() and similar shader modify calls to control the final color output of a material. The callback receives a ColorComponents struct and should return an object with a `color` property ({ r, g, b }) and an `opacity` property (number).
* Registers a callback to customize how color components are combined in the fragment shader. This hook can be used inside <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>.modify() and similar shader modify calls to control the final color output of a material. The callback receives color components (baseColor, diffuse, ambientColor, ambient, specularColor, specular, emissive, opacity) and returns a vec4 for the final color.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we describe the input as being an object with the properties baseColor, diffuse, ambientColor, etc? I think it would be important to describe the size of each item (e.g. position/normal are vec3s, texture coordinates are vec2s, color is a vec4) -- although maybe rather than using terms like vec3 we could describe it as "a vector with three components" to avoid referencing the vec3 type, since there aren't user-facing docs for that yet. A bullet list might work if that's too much info to put in one sentence.

One other note is that when we refer to a name of a property/variable/etc in code, such as when listing properties here, we should put the names in backticks so they render as code (baseColor instead of baseColor.)

Copy link
Author

@Abhayaj247 Abhayaj247 Jul 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/**
 * @function combineColors
 * @experimental
 * @description
 * Registers a callback to customize how color components are combined in the fragment shader. This hook can be used inside <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>.modify() and similar shader modify calls to control the final color output of a material. The callback receives an object with the following properties:
 *
 * - `baseColor`: a vector with three components representing the base color (red, green, blue)
 * - `diffuse`: a single number representing the diffuse reflection
 * - `ambientColor`: a vector with three components representing the ambient color
 * - `ambient`: a single number representing the ambient reflection
 * - `specularColor`: a vector with three components representing the specular color
 * - `specular`: a single number representing the specular reflection
 * - `emissive`: a vector with three components representing the emissive color
 * - `opacity`: a single number representing the opacity
 *
 * The callback should return a vector with four components (red, green, blue, alpha) for the final color.
 *
 * This hook is available in:
 * - <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>
 * - <a href="#/p5/baseNormalShader">baseNormalShader()</a>
 * - <a href="#/p5/baseColorShader">baseColorShader()</a>
 * - <a href="#/p5/baseStrokeShader">baseStrokeShader()</a>
 * - <a href="#/p5/baseFilterShader">baseFilterShader()</a>
 *
 * @param {function} callback
 *        A callback function which receives the object described above and returns a vector with four components for the final color.
 *
 * @example
 * <div modernizr='webgl'>
 * <code>
 * let myShader;
 * function setup() {
 *   createCanvas(200, 200, WEBGL);
 *   myShader = baseMaterialShader().modify(() => {
 *     combineColors(components => {
 *       // Custom color combination: add a red tint
 *       let r = components.baseColor[0] * components.diffuse +
 *               components.ambientColor[0] * components.ambient +
 *               components.specularColor[0] * components.specular +
 *               components.emissive[0] + 0.2;
 *       let g = components.baseColor[1] * components.diffuse +
 *               components.ambientColor[1] * components.ambient +
 *               components.specularColor[1] * components.specular +
 *               components.emissive[1];
 *       let b = components.baseColor[2] * components.diffuse +
 *               components.ambientColor[2] * components.ambient +
 *               components.specularColor[2] * components.specular +
 *               components.emissive[2];
 *       return [r, g, b, components.opacity];
 *     });
 *   });
 * }
 * function draw() {
 *   background(255);
 *   shader(myShader);
 *   lights();
 *   noStroke();
 *   fill('red');
 *   sphere(50);
 * }
 * </code>
 * </div>
 */
 

@davepagurek Thank you for your feedback! I’ve updated the documentation for combineColors to describe the input as an object with each property listed in a bullet list, using backticks for property names and describing the size of each in plain language. The example now uses array notation for vector properties. Please let me know if you’d like any further adjustments.

* Registers a callback to customize how color components are combined in the fragment shader. This hook can be used inside <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>.modify() and similar shader modify calls to control the final color output of a material. The callback receives color components (baseColor, diffuse, ambientColor, ambient, specularColor, specular, emissive, opacity) and returns a vec4 for the final color.
*
* This hook is available in:
* - <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davepagurek Thank you! I appreciate your guidance throughout this process. If there’s anything else you’d like me to adjust or clarify, please let me know.

*/

/**
* @function getPointSize
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a heads up -- currently the only public base shaders are:

The point shader, while it has some hooks, is currently still private, as we may end up using the stroke shader to render points in the future.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/**
 * @function getPointSize
 * @experimental
 * @description
 * Registers a callback to modify the size of points when rendering with a shader.
 *
 * This hook can be used inside the following shader modify functions:
 * - <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>.modify()
 * - <a href="#/p5/baseNormalShader">baseNormalShader()</a>.modify()
 * - <a href="#/p5/baseColorShader">baseColorShader()</a>.modify()
 * - <a href="#/p5/baseStrokeShader">baseStrokeShader()</a>.modify()
 * - <a href="#/p5/baseFilterShader">baseFilterShader()</a>.modify()
 *
 * Use this hook when drawing points (for example, with the point() function in WEBGL mode).
 * The callback receives the current point size (number) and should return the new size (number).
 *
 * This hook is available in:
 * - <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>
 * - <a href="#/p5/baseNormalShader">baseNormalShader()</a>
 * - <a href="#/p5/baseColorShader">baseColorShader()</a>
 * - <a href="#/p5/baseStrokeShader">baseStrokeShader()</a>
 * - <a href="#/p5/baseFilterShader">baseFilterShader()</a>
 *
 * @param {function} callback
 *        A callback function which receives and returns the point size.
 *
 * @example
 * <div modernizr='webgl'>
 * <code>
 * let myShader;
 * function setup() {
 *   createCanvas(200, 200, WEBGL);
 *   myShader = baseMaterialShader().modify(() => {
 *     getPointSize(size => {
 *       // Make points pulse in size over time
 *       return size * (1.0 + 0.5 * sin(millis() * 0.002));
 *     });
 *   });
 * }
 * function draw() {
 *   background(255);
 *   shader(myShader);
 *   strokeWeight(20);
 *   stroke('blue');
 *   point(0, 0);
 * }
 * </code>
 * </div>
 */
 

@davepagurek Thank you for the clarification regarding public base shaders. I’ve updated the documentation for getPointSize to reference only the public shaders and removed any mention of private or internal shaders. Please let me know if you have any further suggestions or preferences.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think getPointSize itself is only present in the base point shader, so I think we don't need this one.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think getPointSize itself is only present in the base point shader, so I think we don't need this one.

@davepagurek Thank you for clarifying! I have removed the documentation for getPointSize since it is only present in the base point shader and not part of the public shaders.
Please let me know if there’s anything else I should update.

@Abhayaj247
Copy link
Author

Abhayaj247 commented Jul 9, 2025

@davepagurek Thank you for your thoughtful feedback and guidance throughout this process. I have addressed all the points you raised:

  • The documentation for combineColors now describes the input as an object with each property listed in a bullet list, using backticks for property names and describing the size of each in plain language. The example uses array notation for vector properties.
  • The documentation for getPointSize has been updated to reference only the public base shaders, with a clear and readable format.
  • All other formatting and clarity suggestions have been incorporated as well.

Please see the updated code blocks above for reference.

If you have any further suggestions or would like additional adjustments, I’m happy to make them!

@Abhayaj247 Abhayaj247 requested a review from davepagurek July 9, 2025 14:45
@davepagurek
Copy link
Contributor

Thanks @Abhayaj247, the docs are looking good! I think maybe we're ready to give the other hooks the same treatment now.

@Abhayaj247
Copy link
Author

Thanks @Abhayaj247, the docs are looking good! I think maybe we're ready to give the other hooks the same treatment now.

@davepagurek Thank you so much for your guidance and support throughout this process! I’m glad the documentation updates meet your expectations. I’ll proceed to document the remaining hooks in the same style.
Please let me know if you have any specific preferences or additional feedback as I work on those.

@Abhayaj247
Copy link
Author

Hi @davepagurek ,

As I continue updating the shader documentation, I’ve reviewed the codebase and found these hooks as the remaining ones that appear to be public or user-facing:

  • beforeVertex
  • afterVertex
  • beforeFragment
  • afterFragment
  • getFinalColor
  • shouldDiscard
  • getLocalNormal
  • getWorldNormal
  • getUV
  • getVertexColor

Additionally, I noticed hooks like getLinePosition, getLineCenter, and getStrokeWeight in the codebase, but they aren’t referenced in the main documentation. My understanding is that these are likely internal, but please let me know if you’d like them included as well.

Could you please confirm that this list covers all the hooks intended for user documentation? Once confirmed, I’ll proceed to document them in the new style.

Thank you for your guidance!

@davepagurek
Copy link
Contributor

Hi @Abhayaj247! I think some of those, e.g. getUV, are from 1.x using an earlier beta of the hooks API, and are no longer present in the 2.0 branch. The ones to document are the ones in the tables on these pages on the beta.p5js.org 2.0 reference:

@Abhayaj247
Copy link
Author

Hi @davepagurek Thank you for clarifying! I’ll reference the tables on the official 2.0 beta documentation pages and ensure that only those hooks are documented. I’ll update the docs accordingly and let you know once it’s ready for review.

@Abhayaj247 Abhayaj247 force-pushed the update-strands-docs branch 2 times, most recently from 4e5489f to 1d01ca8 Compare July 11, 2025 08:31
@Abhayaj247
Copy link
Author

Abhayaj247 commented Jul 11, 2025

Hi @davepagurek

I’ve now added documentation for the remaining hooks listed in the tables for the following shaders in the 2.0 reference :

The newly documented hooks are :

  • beforeVertex
  • getObjectInputs
  • getCameraInputs
  • afterVertex
  • beforeFragment
  • getPixelInputs
  • shouldDiscard
  • getFinalColor
  • afterFragment
  • getColor

The hooks getWorldInputs and combineColors were already documented in previous updates.

Please let me know if there are any further adjustments or if you’d like me to include any additional hooks.

Thank you again for your guidance!

@Abhayaj247
Copy link
Author

Hi @davepagurek ,

Just a gentle reminder regarding my previous comment about the updated documentation for the public shader hooks in ShaderGenerator.js.

I’ve made the changes as per the official 2.0 reference tables and ensured the documentation style and examples are consistent.

If you have a moment, could you please review and let me know if any further adjustments are needed?

Thank you for your time!

* let myShader;
* function setup() {
* createCanvas(200, 200, WEBGL);
* myShader = baseColorShader().modify(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently this (and the examples below too) don't draw anything; could we update them to demonstrate the changes visually?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently this (and the examples below too) don't draw anything; could we update them to demonstrate the changes visually?

function draw() {
  background(220);
  shader(myShader);
  noStroke();
  fill('orange');
  box(100);
}

@davepagurek , Updated all examples to include a draw() function that draws a shape and applies the shader, so the effect is visually demonstrated.

* myShader = baseColorShader().modify(() => {
* getObjectInputs(inputs => {
* // Raise all vertices by 10 units
* inputs.position[1] += 10;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to before, we'd need to use .y here. It might also be useful to change the y value based on the x value, e.g. to make a sine wave along an object, rather than just a constant offset, as it might not be obvious visually what the change has been for that.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to before, we'd need to use .y here. It might also be useful to change the y value based on the x value, e.g. to make a sine wave along an object, rather than just a constant offset, as it might not be obvious visually what the change has been for that.

getObjectInputs(inputs => {
  // Create a sine wave along the x axis in object space
  inputs.position.y += 20 * sin(inputs.position.x * 0.1 + millis() * 0.002);
  return inputs;
});

@davepagurek , Changed all vector accesses to use .x, .y, .z etc., and updated the example to use a sine wave for a visually clear effect.

* myShader = baseColorShader().modify(() => {
* beforeVertex(() => {
* // Set up a variable for later use
* let wave = sin(millis() * 0.001);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think to have a variable for later use within the same shader, we need support for shader-level globals. We currently have varyings only, which are for passing data between the vertex and fragment shader, where the before/after hooks aren't super useful. Maybe we don't need examples for before/after until we have real support for those? @lukeplowden do you know if we have an issue for that yet?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think to have a variable for later use within the same shader, we need support for shader-level globals. We currently have varyings only, which are for passing data between the vertex and fragment shader, where the before/after hooks aren't super useful. Maybe we don't need examples for before/after until we have real support for those? @lukeplowden do you know if we have an issue for that yet?

/**
 * @function beforeVertex
 * ...
 * Note: This hook is currently limited to per-vertex operations; storing variables for later use is not supported.
 */

@davepagurek ,Removed the @example blocks for beforeVertex and afterVertex hooks, and left a note about current limitations.

* myShader = baseMaterialShader().modify(() => {
* combineColors(components => {
* // Custom color combination: add a red tint
* let r = components.baseColor[0] * components.diffuse +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vector components currently need to be accessed via x, y, z, w, r, g, b, or a properties rather than by array access.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vector components currently need to be accessed via x, y, z, w, r, g, b, or a properties rather than by array access.

let r = components.baseColor.r * components.diffuse +
        components.ambientColor.r * components.ambient +
        components.specularColor.r * components.specular +
        components.emissive.r + 0.2;

@davepagurek ,Updated all color/vector accesses to use property names instead of array indices.

* @function getObjectInputs
* @description
* Registers a callback to modify the properties of each vertex before any transformations are applied in the vertex shader. This hook can be used inside <a href="#/p5/baseColorShader">baseColorShader()</a>.modify() and similar shader modify calls to move, color, or otherwise modify the raw model data. The callback receives an object with the following properties:
* - `position`: `[x, y, z]` — the original position of the vertex
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we continue using the same "a vector with three components" terminology from above everywhere?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we continue using the same "a vector with three components" terminology from above everywhere?

 * - `position`: a vector with three components representing the position after camera transformation
 * - `normal`: a vector with three components representing the normal after camera transformation
 * - `texCoord`: a vector with two components representing the texture coordinates
 * - `color`: a vector with four components representing the color of the vertex

@davepagurek ,Updated all doc blocks to consistently use the phrase “a vector with three components” (or “four components”, etc.) for all relevant properties, as requested.

* @description
* Registers a callback to modify the properties of each fragment (pixel) before the final color is calculated in the fragment shader. This hook can be used inside <a href="#/p5/baseMaterialShader">baseMaterialShader()</a>.modify() and similar shader modify calls to change opacity or other per-pixel properties. The callback receives an object with the following properties:
* - `opacity`: a number between 0 and 1 for the pixel's transparency
* (Other properties may be available depending on the shader.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could do a bullet list for the properties in each shader?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could do a bullet list for the properties in each shader?

* - `opacity`: a number between 0 and 1 for the pixel's transparency
* - (Other properties may be available depending on the shader.)

@davepagurek ,All callback object properties are now listed as bullet points in the doc blocks.

* myShader = baseFilterShader().modify(() => {
* getColor((inputs, canvasContent) => {
* // Return the original color
* return getTexture(canvasContent, inputs.texCoord);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to do some kind of change here, e.g. warping the coordinate or changing the color

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be nice to do some kind of change here, e.g. warping the coordinate or changing the color

getColor((inputs, canvasContent) => {
  // Warp the texture coordinates for a wavy effect
  let warped = [inputs.texCoord.x, inputs.texCoord.y + 0.1 * sin(inputs.texCoord.x * 10.0)];
  return getTexture(canvasContent, warped);
});

@davepagurek ,Updated the getColor example to warp the coordinates for a visible effect.

* myShader = baseColorShader().modify(() => {
* getCameraInputs(inputs => {
* // Tint all vertices blue
* inputs.color[2] = 1.0;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might make sense for the world/object/camera inputs hooks to show at least one position example, as the position space is the main difference between them (in world space, if you move an object around with translate(), the coordinates change; in object space, the coordinates stay the same with the object as it moves)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might make sense for the world/object/camera inputs hooks to show at least one position example, as the position space is the main difference between them (in world space, if you move an object around with translate(), the coordinates change; in object space, the coordinates stay the same with the object as it moves)

getWorldInputs(inputs => {
  // Move the vertex up and down in a wave in world space
  // In world space, moving the object (e.g., with translate()) will affect these coordinates
  inputs.position.y += 20 * sin(millis() * 0.001 + inputs.position.x * 0.05);
  return inputs;
});

@davepagurek ,Added a position-modifying example to each of getObjectInputs, getWorldInputs, and getCameraInputs, with comments explaining the coordinate space.

@Abhayaj247
Copy link
Author

Thank you for the detailed feedback @davepagurek ! I have addressed all the points as follows :

1. Visual Examples :

  • All code examples now include a draw() function that draws a shape and applies the shader, so the effect of each hook is visually demonstrated.

2. Vector Property Access :

  • All vector and color accesses now use property notation (e.g., .y, .r, .g, .b) instead of array indices, as requested.

3. Sine Wave Example :

  • The getObjectInputs example now uses a sine wave along the x axis for a visually clear effect, rather than a constant offset.

4. before/afterVertex Examples :

  • The beforeVertex and afterVertex hooks no longer have examples, per your suggestion, and include a note about current limitations.

5. Consistent Vector Terminology :

  • All doc blocks use the consistent phrase “a vector with three components” (or “four components”, etc.) for all relevant properties, as requested.

6. Bullet Lists :

  • All callback object properties are now listed as bullet points in the documentation for clarity.

7. getColor Example :

  • The getColor example now warps the coordinates for a visible effect, rather than just returning the original color.

8. Position Examples in Input Hooks :

  • The getObjectInputs, getWorldInputs, and getCameraInputs examples all include a position modification, with comments explaining the coordinate space difference.

If you have any further suggestions, please let me know!

Thank you again for your guidance.

@Abhayaj247 Abhayaj247 requested a review from davepagurek July 17, 2025 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants