diff options
author | Cary Clark <caryclark@skia.org> | 2018-04-16 08:37:38 -0400 |
---|---|---|
committer | Skia Commit-Bot <skia-commit-bot@chromium.org> | 2018-04-16 16:26:20 +0000 |
commit | 2d4bf5f288d91f8d2371c7a970bdfa70dacdd78a (patch) | |
tree | 1aa90b6825682da0963bb48c9325d6912e3923c0 /docs/SkColor4f_Reference.bmh | |
parent | ffbe93296838c3a93a87261cae7f7229b56f1f8a (diff) |
document SkColor.h
SkColor.h uses #define liberally, and has many global symbols,
two things bookmaker hasn't seen in other includes.
Revised .h -> .bmh converter to work with SkColor.h as well
as updating how .bmh indices are built.
Generated SkColor_Reference.bmh for globals, and
SkColor4f_Reference.bmh for class.
Other than the existing comments, this doesn't update the
documentation or add new examples.
Docs-Preview: https://skia.org/?cl=118985
TBR=caryclark@google.com
Bug: skia:6898
Change-Id: I5978257ee0e51319823efbe8dfc467a08c99ffe0
Reviewed-on: https://skia-review.googlesource.com/118985
Commit-Queue: Cary Clark <caryclark@skia.org>
Reviewed-by: Cary Clark <caryclark@skia.org>
Diffstat (limited to 'docs/SkColor4f_Reference.bmh')
-rw-r--r-- | docs/SkColor4f_Reference.bmh | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/docs/SkColor4f_Reference.bmh b/docs/SkColor4f_Reference.bmh new file mode 100644 index 0000000000..71bdb76d1c --- /dev/null +++ b/docs/SkColor4f_Reference.bmh @@ -0,0 +1,193 @@ +#Topic Color4f +#Alias Color4f_Reference + +#Struct SkColor4f + +The float values are 0...1 unpremultiplied + +#Subtopic Overview + #Subtopic Subtopic + #Populate + ## +## + +#Subtopic Operator +#Populate +## + +#Subtopic Member_Function +#Populate +## + +#Member float fR +## + +#Member float fG +## + +#Member float fB +## + +#Member float fA +## + +# ------------------------------------------------------------------------------ + +#Method bool operator==(const SkColor4f& other)_const +#In Operator +#Line # incomplete ## + +#Param other incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method bool operator!=(const SkColor4f& other)_const +#In Operator +#Line # incomplete ## + +#Param other incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method const float* vec() const +#In incomplete +#Line # incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method float* vec() +#In incomplete +#Line # incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method static SkColor4f Pin(float r, float g, float b, float a) +#In incomplete +#Line # incomplete ## + +#Param r incomplete ## +#Param g incomplete ## +#Param b incomplete ## +#Param a incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method static SkColor4f FromColor(SkColor) +#In incomplete +#Line # incomplete ## + +Convert to SkColor4f, assuming SkColor is sRGB + +#Param SkColor incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method SkColor toSkColor() const +#In incomplete +#Line # incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method SkColor4f pin() const +#In incomplete +#Line # incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +# ------------------------------------------------------------------------------ + +#Method SkPM4f premul() const +#In incomplete +#Line # incomplete ## + +#Return incomplete ## + +#Example +// incomplete +## + +#SeeAlso incomplete + +#Method ## + +#Struct SkColor4f ## + +#Topic Color4f ## |