remoting/client/frame_consumer.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef REMOTING_CLIENT_FRAME_CONSUMER_H_
   6 #define REMOTING_CLIENT_FRAME_CONSUMER_H_
   7
   8 #include "third_party/skia/include/core/SkRect.h"
   9 #include "third_party/skia/include/core/SkRegion.h"
  10 #include "third_party/skia/include/core/SkSize.h"
  11
  12 namespace pp {
  13 class ImageData;
  14 } // namespace pp
  15
  16 namespace remoting {
  17
  18 class FrameConsumer {
  19  public:
  20   // Accepts a buffer to be painted to the screen. The buffer's dimensions and
  21   // relative position within the frame are specified by |clip_area|. Only
  22   // pixels falling within |region| and the current clipping area are painted.
  23   // The function assumes that the passed buffer was scaled to fit a window
  24   // having |view_size| dimensions.
  25   //
  26   // N.B. Both |clip_area| and |region| are in output coordinates relative to
  27   // the frame.
  28   virtual void ApplyBuffer(const SkISize& view_size,
  29                            const SkIRect& clip_area,
  30                            pp::ImageData* buffer,
  31                            const SkRegion& region) = 0;
  32
  33   // Accepts a buffer that couldn't be used for drawing for any reason (shutdown
  34   // is in progress, the view area has changed, etc.). The accepted buffer can
  35   // be freed or reused for another drawing operation.
  36   virtual void ReturnBuffer(pp::ImageData* buffer) = 0;
  37
  38   // Set the dimension of the entire host screen.
  39   virtual void SetSourceSize(const SkISize& source_size,
  40                              const SkIPoint& dpi) = 0;
  41
  42  protected:
  43   FrameConsumer() {}
  44   virtual ~FrameConsumer() {}
  45
  46  private:
  47   DISALLOW_COPY_AND_ASSIGN(FrameConsumer);
  48 };
  49
  50 }  // namespace remoting
  51
  52 #endif  // REMOTING_CLIENT_FRAME_CONSUMER_H_