skia2/docs/SkColor4f_Reference.bmh
Cary Clark 2d4bf5f288 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>
2018-04-16 16:26:20 +00:00

194 lines
2.7 KiB
Plaintext

#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 ##