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
[Documentation]: Add documentation to the Effect classes #8276
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,11 +5,23 @@ | |
using System; | ||
namespace Microsoft.Xna.Framework.Graphics | ||
{ | ||
/// <summary> | ||
/// Contains an effect subclass which is used to load data for an EffectMaterialContent type. | ||
/// </summary> | ||
/// <remarks> | ||
/// For most purposes, this type can be ignored, and treated exactly like a regular effect. | ||
/// When an EffectMaterial type is loaded from .xnb format, its parameter values and textures | ||
/// are also loaded and automatically set on the effect, in addition to the HLSL shader code. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We might want to remove the reference to HLSL here. by the time the Effect is being used the onderlying shader will be platform specific , e.g GLSL HLSL, metal etc. |
||
/// Use this class to write a content pipeline extension to store materials inside a custom data type. | ||
/// </remarks> | ||
public class EffectMaterial : Effect | ||
{ | ||
/// <summary> | ||
/// Creates a new instance of <see cref="EffectMaterial"/>. | ||
/// </summary> | ||
/// <param name="cloneSource">An instance of an object to copy initialization data from.</param> | ||
public EffectMaterial (Effect cloneSource) : base(cloneSource) | ||
{ | ||
} | ||
} | ||
} | ||
|
||
} |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be helpful to know what kind of clone? A shallow one (just the Effect properties) or does it do a deep clone? That might be too much info.