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

Should ofCubeMapsData() & ofShadowsData() be private? documentation missing #8409

Open
danomatika opened this issue Mar 31, 2025 · 3 comments
Assignees

Comments

@danomatika
Copy link
Contributor

danomatika commented Mar 31, 2025

With of_v20250330_osx_release:

Is ofCubeMapsData() something public or really only needed internally for ofCubeMap and ofMaterial? There is no comment to explain its usage and the naming is ambiguous to me.

There is really a dearth of commenting on this class other than the load functions. Sorry if this is a graphics pattern which I should recognize, however I don't think we should assume that for stuff in the core.

@danomatika
Copy link
Contributor Author

danomatika commented Mar 31, 2025

If this is indeed something internal, maybe it can be hidden somehow as a friend function, within of::priv, etc.

@danomatika danomatika changed the title ofCubeMapsData() documentation missing ofCubeMapsData() documentation missing, should be private? Mar 31, 2025
@danomatika danomatika changed the title ofCubeMapsData() documentation missing, should be private? Should ofCubeMapsData() be private? documentation missing Mar 31, 2025
@danomatika
Copy link
Contributor Author

The same holds true for ofShadowsData() in ofShadow.h.

@danomatika danomatika changed the title Should ofCubeMapsData() be private? documentation missing Should ofCubeMapsData() & ofShadowsData() be private? documentation missing Mar 31, 2025
@NickHardeman
Copy link
Contributor

ofCubeMapsData() and ofShadowsData() is replicating the ofLightsData() method here:

std::vector<std::weak_ptr<ofLight::Data> > & ofLightsData();

Useful for storing the data about all the cube maps and shadows that have been created, mostly for internal use. A user could find this useful for passing the information to their own shaders but seems unlikely.
Documentation comments would be helpful throughout the entire ofCubeMap and ofShadow classes.

@NickHardeman NickHardeman self-assigned this Apr 4, 2025
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

No branches or pull requests

2 participants