Add SkAndroidCodec::getPixels

include/codec/SkAndroidCodec.h

 /*
  * Copyright 2015 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #ifndef SkAndroidCodec_DEFINED
 #define SkAndroidCodec_DEFINED
 
@@ skipping 125 matching lines @@
         AndroidOptions()
             : fZeroInitialized(SkCodec::kNo_ZeroInitialized)
             , fSubset(nullptr)
             , fColorPtr(nullptr)
             , fColorCount(nullptr)
             , fSampleSize(1)
         {}
 
         /**
          *  Indicates is destination pixel memory is zero initialized.
+         *
+         *  The default is SkCodec::kNo_ZeroInitialized.
          */
         SkCodec::ZeroInitialized fZeroInitialized;
 
         /**
          *  If not NULL, represents a subset of the original image to decode.
          *
          *  Must be within the bounds returned by getInfo().
          *
          *  If the EncodedFormat is kWEBP_SkEncodedFormat, the top and left
          *  values must be even.
+         *
+         *  The default is NULL, meaning a decode of the entire image.
          */
         SkIRect* fSubset;
 
         /**
          *  If the client has requested a decode to kIndex8_SkColorType
          *  (specified in the SkImageInfo), then the caller must provide
          *  storage for up to 256 SkPMColor values in fColorPtr.  On success,
          *  the codec must copy N colors into that storage, (where N is the
          *  logical number of table entries) and set fColorCount to N.
          *
          *  If the client does not request kIndex8_SkColorType, then the last
          *  two parameters may be NULL. If fColorCount is not null, it will be
          *  set to 0.
+         *
+         *  The default is NULL for both pointers.
          */
         SkPMColor* fColorPtr;
         int*       fColorCount;
 
         /**
          *  The client may provide an integer downscale factor for the decode.
          *  The codec may implement this downscaling by sampling or another
          *  method if it is more efficient.
+         *
+         *  The default is 1, representing no downscaling.
          */
         int fSampleSize;
     };
 
     /**
      *  Decode into the given pixels, a block of memory of size at
      *  least (info.fHeight - 1) * rowBytes + (info.fWidth *
      *  bytesPerPixel)
      *
      *  Repeated calls to this function should give the same results,
@@ skipping 13 matching lines @@
      *
      *  If info is kIndex8_SkColorType, then the caller must provide storage for up to 256
      *  SkPMColor values in options->fColorPtr. On success the codec must copy N colors into
      *  that storage, (where N is the logical number of table entries) and set
      *  options->fColorCount to N.
      *
      *  If info is not kIndex8_SkColorType, options->fColorPtr and options->fColorCount may
      *  be nullptr.
      *
      *  The AndroidOptions object is also used to specify any requested scaling or subsetting
-     *  using options->fSampleSize and options->fSubset.
+     *  using options->fSampleSize and options->fSubset. If NULL, the defaults (as specified above
+     *  for AndroidOptions) are used.
      *
      *  @return Result kSuccess, or another value explaining the type of failure.
      */
     // FIXME: It's a bit redundant to name this getAndroidPixels() when this class is already
     //        called SkAndroidCodec.  On the other hand, it's may be a bit confusing to call
     //        this getPixels() when it is a slightly different API than SkCodec's getPixels().
     //        Maybe this should be decode() or decodeSubset()?
     SkCodec::Result getAndroidPixels(const SkImageInfo& info, void* pixels, size_t rowBytes,
             const AndroidOptions* options);
 
     /**
-     *  Simplified version of getAndroidPixels() where we supply the default AndroidOptions.
+     *  Simplified version of getAndroidPixels() where we supply the default AndroidOptions as
+     *  specified above for AndroidOptions.
      *
      *  This will return an error if the info is kIndex_8_SkColorType and also will not perform
      *  any scaling or subsetting.
      */
     SkCodec::Result getAndroidPixels(const SkImageInfo& info, void* pixels, size_t rowBytes);
 
+    SkCodec::Result getPixels(const SkImageInfo& info, void* pixels, size_t rowBytes) {
+        return this->getAndroidPixels(info, pixels, rowBytes);
+    }
+
 protected:
 
     SkAndroidCodec(SkCodec*);
 
     SkCodec* codec() const { return fCodec.get(); }
 
     virtual SkISize onGetSampledDimensions(int sampleSize) const = 0;
 
     virtual bool onGetSupportedSubset(SkIRect* desiredSubset) const = 0;
 
     virtual SkCodec::Result onGetAndroidPixels(const SkImageInfo& info, void* pixels,
             size_t rowBytes, const AndroidOptions& options) = 0;
 
 private:
 
     // This will always be a reference to the info that is contained by the
     // embedded SkCodec.
     const SkImageInfo& fInfo;
 
     SkAutoTDelete<SkCodec> fCodec;
 };
 #endif // SkAndroidCodec_DEFINED