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

Jump to bottom

Documentation for Color[index] is incorrect #693

Open
johang88 opened this issue May 2, 2020 · 1 comment
Open

Documentation for Color[index] is incorrect #693

johang88 opened this issue May 2, 2020 · 1 comment
Labels
area-Graphics bug good first issue

Comments

@johang88
Copy link
Contributor

@johang88 johang88 commented May 2, 2020 •
edited

Release Type: Github
Version: master

Describe the bug
The documentation states "The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component".

The actual implementation uses:

switch (index)
{
	case 0: return R;
	case 1: return G;
	case 2: return B;
	case 3: return A;
}

Expected behavior
Documentation should match the implementation
@johang88 johang88 added the bug label May 2, 2020
@Eideren
Copy link
Collaborator

@Eideren Eideren commented May 2, 2020

Line in question:

stride/sources/core/Stride.Core.Mathematics/Color.cs

Line 222 in f2aa3ed

/// <param name="index">The index of the component to access. Use 0 for the alpha component, 1 for the red component, 2 for the green component, and 3 for the blue component.</param>

@ghost ghost mentioned this issue Jun 2, 2020
Merged
6 tasks
@Eideren Eideren mentioned this issue Jun 3, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-Graphics bug good first issue
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@johang88 @Eideren