From e9c81ee2ea3a77fb4641435a97fef447c1b85128 Mon Sep 17 00:00:00 2001 From: skia-bookmaker Date: Thu, 24 May 2018 06:29:18 +0000 Subject: Update markdown files Automatic commit by the Housekeeper-Nightly-Bookmaker bot. TBR=rmistry@google.com NO_MERGE_BUILDS Change-Id: Ife9566f2c606183fcaaf55aabea65a286af48816 Reviewed-on: https://skia-review.googlesource.com/129892 Commit-Queue: Reviewed-by: --- site/user/api/SkImageInfo_Reference.md | 207 ++++++++++++--------------------- 1 file changed, 77 insertions(+), 130 deletions(-) (limited to 'site') diff --git a/site/user/api/SkImageInfo_Reference.md b/site/user/api/SkImageInfo_Reference.md index f6cf52c5d7..0ba1d04098 100644 --- a/site/user/api/SkImageInfo_Reference.md +++ b/site/user/api/SkImageInfo_Reference.md @@ -18,18 +18,14 @@ but Image and Topic Description - Constructors - functions that construct SkImageInfo - - Functions global and class member functions - - Operators - operator overloading methods - + Members + member values + + Related Functions similar member functions grouped together @@ -39,7 +35,7 @@ but Image and Constant -SkImageInfo related constants are defined by enum, enum class, #define, const, and constexpr. +SkYUVAIndex related constants are defined by enum, enum class, #define, const, and constexpr. @@ -811,26 +807,26 @@ true if Color Alpha is always set to 1.0 ## SkColorTypeValidateAlphaType 
-bool SkColorTypeValidateAlphaType(SkColorType colorType, SkAlphaType alphaType,
+bool SkColorTypeValidateAlphaType(SkColorType colorType, SkAlphaType alphaType,
                                   SkAlphaType* canonical = nullptr)
-Returns true if canonical can be set to a valid Alpha Type for colorType. If -there is more than one valid canonicalAlpha Type, set to alphaType, if valid. +Returns true if canonical can be set to a valid Alpha Type for colorType. If +there is more than one valid canonicalAlpha Type, set to alphaType, if valid. If true is returned and canonical is not nullptr, store valid Alpha Type. -Returns false only if alphaType is kUnknown_SkAlphaType, color type is not +Returns false only if alphaType is kUnknown_SkAlphaType, color type is not kUnknown_SkColorType, and Color Type is not always opaque. If false is returned, canonical is ignored. For kUnknown_SkColorType: set canonical to kUnknown_SkAlphaType and return true. For kAlpha_8_SkColorType: set canonical to kPremul_SkAlphaType or -kOpaque_SkAlphaType and return true if alphaType is not kUnknown_SkAlphaType. +kOpaque_SkAlphaType and return true if alphaType is not kUnknown_SkAlphaType. For kRGB_565_SkColorType, kRGB_888x_SkColorType, kRGB_101010x_SkColorType, and kGray_8_SkColorType: set canonical to kOpaque_SkAlphaType and return true. For kARGB_4444_SkColorType, kRGBA_8888_SkColorType, kBGRA_8888_SkColorType, -kRGBA_1010102_SkColorType, and kRGBA_F16_SkColorType: set canonical to alphaType -and return true if alphaType is not kUnknown_SkAlphaType. +kRGBA_1010102_SkColorType, and kRGBA_F16_SkColorType: set canonical to alphaType +and return true if alphaType is not kUnknown_SkAlphaType. ### Parameters @@ -851,7 +847,7 @@ and return true if alphaType is not Alpha Type can be associated with colorType +true if valid Alpha Type can be associated with colorType ### Example @@ -932,16 +928,71 @@ Used by tests to iterate through all valid values. SkImage::MakeFromYUVTexturesCopySkImage::MakeFromNV12TexturesCopy -# Struct SkImageInfo +# Struct SkYUVAIndex ## Constant -SkImageInfo related constants are defined by enum, enum class, #define, const, and constexpr. +SkYUVAIndex related constants are defined by enum, enum class, #define, const, and constexpr. +
Topic Description
+ + +
TopicDescription
+ + +## Member_Function + + +SkYUVAIndex member functions read and modify the structure properties. + + + +
TopicDescription
+ + +## Member + + +SkYUVAIndex members may be read and written directly without using a member function.
Topic Description
+ + +## Related_Function + + +SkYUVAIndex global, struct, and class related member functions share a topic. + + + +
TopicDescription
+Describes which image source and which channel to read for each planes. + +### Members + + + + + + + + + + + + + + + +
TypeNameDescription
intfIndex +Describes which image source to be reading from. The Alpha plane is optional and could be set to -1. +
SkImageSourceChannelfChannel +Describes which of the channel to read from. +
+ +# Struct SkImageInfo Describes pixel dimensions and encoding. Bitmap, Image, PixMap, and Surface can be created from Image Info. Image Info can be retrieved from Bitmap and Pixmap, but not from Image and Surface. For example, Image and Surface @@ -954,7 +1005,7 @@ and green; and Color Space, the range and ## Member Function -SkImageInfo member functions read and modify the structure properties. +SkYUVAIndex member functions read and modify the structure properties. @@ -986,22 +1037,6 @@ SkImageInfo member functions read and modify the structure properties. - - - - - - - - - - - - - - - - @@ -1108,89 +1143,25 @@ SkImageInfo member functions read and modify the structure properties. ## Related Function -SkImageInfo global, struct, and class related member functions share a topic. +SkYUVAIndex global, struct, and class related member functions share a topic.
Topic Description
MakeUnknown creates Image Info with kUnknown_SkColorType, kUnknown_SkAlphaType
SkAlphaTypeIsOpaquereturns if Alpha Type equals kOpaque_SkAlphaType
SkColorTypeBytesPerPixelreturns Color Type byte size
SkColorTypeIsAlwaysOpaquereturns if Color Type includes Color Alpha
SkColorTypeValidateAlphaTypereturns if Alpha Type is valid
alphaType returns Alpha Type
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - -
Topic Description
Alpha Typeencoding for pixel transparency
Alpha Type Opaquehints all pixels are opaque
Alpha Type Premulstores components scaled by Alpha
Alpha Type Unpremulstores components without Alpha scaling
Color Typeencoding for pixel color
Color Type ARGB 4444encodes ARGB in 16 bits
Color Type Alpha 8encodes transparency only
Color Type BGRA 8888encodes ARGB Little_Endian in 32 bits
Color Type Gray 8encodes level of grayscale in 8 bits
Color Type RGBA 1010102encodes ARGB ten bits per color component
Color Type RGBA 8888encodes ARGB Big_Endian in 32 bits
Color Type RGBA F16encodes ARGB as half floats
Color Type RGB 101010encodes RGB ten bits per color component
Color Type RGB 565encodes RGB in 16 bits
Color Type RGB 888encodes RGB in 32 bits
Property metrics and attributes
Utility rarely called management functions
YUV ColorSpacecolor range of YUV pixels
## Constructor -SkImageInfo can be constructed or initialized by these functions, including C++ class constructors. +SkYUVAIndex can be constructed or initialized by these functions, including C++ class constructors. @@ -1215,24 +1186,16 @@ SkImageInfo can be constructed or initialized by these functions, including C++ - - - - - + - - - - - + @@ -1617,22 +1580,6 @@ created Image Info
Topic Description
MakeN32Premul(int width, int height, sk sp<SkColorSpace> cs = nullptr)
MakeN32Premul(const SkISize& size)
MakeS32 creates Image Info with Native_Color_Type, sRGB Color Space
MakeUnknown creates Image Info with kUnknown_SkColorType, kUnknown_SkAlphaType
MakeUnknown(int width, int height)
MakeUnknown()MakeUnknown(int width, int height)
SkImageInfo()
- - - - - - - - - - - - - - - - @@ -2368,7 +2315,7 @@ offset within pixel array ## Operator -SkImageInfo operators inline class member functions with arithmetic equivalents. +SkYUVAIndex operators inline class member functions with arithmetic equivalents.
Topic Description
SkAlphaTypeIsOpaquereturns if Alpha Type equals kOpaque_SkAlphaType
SkColorTypeBytesPerPixelreturns Color Type byte size
SkColorTypeIsAlwaysOpaquereturns if Color Type includes Color Alpha
SkColorTypeValidateAlphaTypereturns if Alpha Type is valid
alphaType returns Alpha Type
-- cgit v1.2.3
Topic Description