/**
 * PANDA 3D SOFTWARE
 * Copyright (c) Carnegie Mellon University.  All rights reserved.
 *
 * All use of this software is subject to the terms of the revised BSD
 * license.  You should have received a copy of this license along
 * with this source code in a file named "LICENSE."
 *
 * @file drawableRegion.h
 * @author drose
 * @date 2002-07-11
 */

#ifndef DRAWABLEREGION_H
#define DRAWABLEREGION_H

#include "pandabase.h"
#include "luse.h"
#include "renderBuffer.h"
#include "typedWritableReferenceCount.h"

/**
 * This is a base class for GraphicsWindow (actually, GraphicsOutput) and
 * DisplayRegion, both of which are conceptually rectangular regions into
 * which drawing commands may be issued.  Sometimes you want to deal with a
 * single display region, and sometimes you want to deal with the whole window
 * at once, particularly for issuing clear commands and capturing screenshots.
 */
class EXPCL_PANDA_DISPLAY DrawableRegion {
public:
  INLINE DrawableRegion();
  INLINE DrawableRegion(const DrawableRegion &copy);
  INLINE void operator = (const DrawableRegion &copy);
  virtual ~DrawableRegion();

  INLINE void copy_clear_settings(const DrawableRegion &copy);

PUBLISHED:
  // It seems awkward to have this type, and also RenderBuffer::Type.
  // However, the fact that RenderBuffer::Type is a bitmask makes it awfully
  // awkward to work with.
  enum RenderTexturePlane {
    RTP_stencil=0,
    RTP_depth_stencil=1,
    RTP_color,
    RTP_aux_rgba_0,
    RTP_aux_rgba_1,
    RTP_aux_rgba_2,
    RTP_aux_rgba_3,
    RTP_aux_hrgba_0,
    RTP_aux_hrgba_1,
    RTP_aux_hrgba_2,
    RTP_aux_hrgba_3,
    RTP_aux_float_0,
    RTP_aux_float_1,
    RTP_aux_float_2,
    RTP_aux_float_3,
    RTP_depth,
    RTP_COUNT
  };

  INLINE void set_clear_color_active(bool clear_color_active);
  INLINE bool get_clear_color_active() const;

  INLINE void set_clear_depth_active(bool clear_depth_active);
  INLINE bool get_clear_depth_active() const;

  INLINE void set_clear_stencil_active(bool clear_stencil_active);
  INLINE bool get_clear_stencil_active() const;

  INLINE void set_clear_color(const LColor &color);
  INLINE const LColor &get_clear_color() const;
  MAKE_PROPERTY(clear_color, get_clear_color, set_clear_color);

  INLINE void set_clear_depth(PN_stdfloat depth);
  INLINE PN_stdfloat get_clear_depth() const;
  MAKE_PROPERTY(clear_depth, get_clear_depth, set_clear_depth);

  INLINE void set_clear_stencil(unsigned int stencil);
  INLINE unsigned int get_clear_stencil() const;
  MAKE_PROPERTY(clear_stencil, get_clear_stencil, set_clear_stencil);

  virtual void set_clear_active(int n, bool clear_aux_active);
  virtual bool get_clear_active(int n) const;

  virtual void set_clear_value(int n, const LColor &clear_value);
  virtual const LColor &get_clear_value(int n) const;

  virtual void disable_clears();
  virtual bool is_any_clear_active() const;

  virtual void set_pixel_zoom(PN_stdfloat pixel_zoom);
  INLINE PN_stdfloat get_pixel_zoom() const;
  INLINE PN_stdfloat get_pixel_factor() const;
  virtual bool supports_pixel_zoom() const;
  MAKE_PROPERTY(pixel_zoom, get_pixel_zoom, set_pixel_zoom);
  MAKE_PROPERTY(pixel_factor, get_pixel_factor);

  static int get_renderbuffer_type(int plane);

public:
  INLINE int get_screenshot_buffer_type() const;
  INLINE int get_draw_buffer_type() const;

protected:
  INLINE void update_pixel_factor();
  virtual void pixel_factor_changed();

protected:
  int _screenshot_buffer_type;
  int _draw_buffer_type;
  int _clear_mask;

private:
  LColor  _clear_value[RTP_COUNT];

  PN_stdfloat _pixel_zoom;
  PN_stdfloat _pixel_factor;
};


#include "drawableRegion.I"

#endif