Skip to content
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

mark waveformrenderer using rendergraph #14188

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

m0dB
Copy link
Contributor

@m0dB m0dB commented Jan 18, 2025

Ports the mark waveformrenderer to a rendergraph node. This can be reviewed and merged independently from the PRs for the other waveformrenderers.


// Render digits using a texture (generated) with digits with blurred dark outline

using namespace rendergraph;

namespace {

// The texture will contain 12 characters: 10 digits, colon and dot
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
// The texture will contain 12 characters: 10 digits, colon and dot
/// The texture will contain 12 characters: 10 digits, colon and dot

And elsewhere, so that it gets picked up by doxygen and IDEs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there a clear policy on this? IMO this is just a comment to help understand the code, not really API doc.

Copy link
Member

Choose a reason for hiding this comment

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

I mean we don't really do API docs because we don't give any stability guarantees.

We don't really have a policy but some time ago we said that we try to use triple slash where it makes sense (i.e. if we add comments to classes, functions or constants). That makes the comment accessible to IDEs/LSP and people can see it when hovering over a method/constant, so that they have the explanation at hand instead of having to scroll to the definition.

Just to clarify: we said that we don't want the full-blown @param syntax (also hard to maintain), just that we add an additional slash so that we get IDE support for free.

Comment on lines +14 to +17
#include "rendergraph/context.h"
#include "rendergraph/geometry.h"
#include "rendergraph/material/texturematerial.h"
#include "rendergraph/vertexupdaters/texturedvertexupdater.h"
Copy link
Member

Choose a reason for hiding this comment

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

These should be before the util includes.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants