Documentation - Graphic3d_Aspects::PolygonOffsets update comments#519
Merged
dpasukhi merged 1 commit intoOpen-Cascade-SAS:IRfrom Jul 16, 2025
Merged
Documentation - Graphic3d_Aspects::PolygonOffsets update comments#519dpasukhi merged 1 commit intoOpen-Cascade-SAS:IRfrom
dpasukhi merged 1 commit intoOpen-Cascade-SAS:IRfrom
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR clarifies misleading documentation by removing an incorrect comment in the image saving routine and updating the documented default units for polygon offsets in the OCC 3D viewer.
- Removed the comment indicating the image is stored in linear RGB colorspace in Image_AlienPixMap.cxx.
- Updated the documented default "units" value in Graphic3d_Aspects.hxx from 0 to 1.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/Visualization/TKService/Image/Image_AlienPixMap.cxx | Removed the incorrect header comment about linear RGB colorspace. |
| src/Visualization/TKService/Graphic3d/Graphic3d_Aspects.hxx | Corrected the default documentation for OCC 3D viewer polygon offsets (units = 1 now). |
Comments suppressed due to low confidence (1)
src/Visualization/TKService/Graphic3d/Graphic3d_Aspects.hxx:227
- Ensure that this updated default documentation (units = 1) aligns with the underlying implementation so that the documentation accurately reflects actual behavior.
//! Default settings for OCC 3D viewer: mode = Aspect_POM_Fill, factor = 1., units = 1.
…en-Cascade-SAS#519) Updated the documented default "units" value in Graphic3d_Aspects.hxx from 0 to 1.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.