209 lines
6.1 KiB
C++
209 lines
6.1 KiB
C++
// Filename: graphicsOutput.h
|
|
// Created by: drose (06Feb04)
|
|
//
|
|
////////////////////////////////////////////////////////////////////
|
|
//
|
|
// PANDA 3D SOFTWARE
|
|
// Copyright (c) 2001 - 2004, Disney Enterprises, Inc. All rights reserved
|
|
//
|
|
// All use of this software is subject to the terms of the Panda 3d
|
|
// Software license. You should have received a copy of this license
|
|
// along with this source code; you will also find a current copy of
|
|
// the license at http://etc.cmu.edu/panda3d/docs/license/ .
|
|
//
|
|
// To contact the maintainers of this program write to
|
|
// panda3d-general@lists.sourceforge.net .
|
|
//
|
|
////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef GRAPHICSOUTPUT_H
|
|
#define GRAPHICSOUTPUT_H
|
|
|
|
#include "pandabase.h"
|
|
|
|
#include "graphicsChannel.h"
|
|
#include "graphicsPipe.h"
|
|
#include "displayRegion.h"
|
|
#include "graphicsStateGuardian.h"
|
|
#include "drawableRegion.h"
|
|
#include "renderBuffer.h"
|
|
|
|
#include "typedWritableReferenceCount.h"
|
|
#include "pStatCollector.h"
|
|
#include "notify.h"
|
|
#include "pmutex.h"
|
|
#include "filename.h"
|
|
#include "pvector.h"
|
|
|
|
class PNMImage;
|
|
|
|
////////////////////////////////////////////////////////////////////
|
|
// Class : GraphicsOutput
|
|
// Description : This is a base class for the various different
|
|
// classes that represent the result of a frame of
|
|
// rendering. The most common kind of GraphicsOutput is
|
|
// a GraphicsWindow, which is a real-time window on the
|
|
// desktop, but another example is GraphicsBuffer, which
|
|
// is an offscreen buffer.
|
|
//
|
|
// The actual rendering, and anything associated with
|
|
// the graphics context itself, is managed by the
|
|
// associated GraphicsStateGuardian (which might output
|
|
// to multiple GraphicsOutput objects).
|
|
//
|
|
// GraphicsOutputs are not actually writable to bam
|
|
// files, of course, but they may be passed as event
|
|
// parameters, so they inherit from
|
|
// TypedWritableReferenceCount instead of
|
|
// TypedReferenceCount for that convenience.
|
|
////////////////////////////////////////////////////////////////////
|
|
class EXPCL_PANDA GraphicsOutput : public TypedWritableReferenceCount, public DrawableRegion {
|
|
protected:
|
|
GraphicsOutput(GraphicsPipe *pipe, GraphicsStateGuardian *gsg,
|
|
const string &name);
|
|
|
|
private:
|
|
GraphicsOutput(const GraphicsOutput ©);
|
|
void operator = (const GraphicsOutput ©);
|
|
|
|
PUBLISHED:
|
|
virtual ~GraphicsOutput();
|
|
|
|
INLINE GraphicsStateGuardian *get_gsg() const;
|
|
INLINE GraphicsPipe *get_pipe() const;
|
|
INLINE const string &get_name() const;
|
|
|
|
INLINE bool has_texture() const;
|
|
INLINE Texture *get_texture() const;
|
|
|
|
INLINE int get_x_size() const;
|
|
INLINE int get_y_size() const;
|
|
INLINE bool has_size() const;
|
|
INLINE bool is_valid() const;
|
|
|
|
virtual bool is_active() const;
|
|
|
|
INLINE int get_sort() const;
|
|
void set_sort(int sort);
|
|
|
|
GraphicsChannel *get_channel(int index);
|
|
void remove_channel(int index);
|
|
|
|
int get_max_channel_index() const;
|
|
bool is_channel_defined(int index) const;
|
|
|
|
int get_num_display_regions() const;
|
|
DisplayRegion *get_display_region(int n) const;
|
|
|
|
GraphicsOutput *make_texture_buffer(const string &name, int x_size, int y_size);
|
|
|
|
INLINE Filename save_screenshot_default(const string &prefix = "screenshot");
|
|
INLINE bool save_screenshot(const Filename &filename);
|
|
INLINE bool get_screenshot(PNMImage &image);
|
|
|
|
public:
|
|
// No need to publish these.
|
|
PT(DisplayRegion) make_scratch_display_region(int x_size, int y_size);
|
|
|
|
public:
|
|
// These are not intended to be called directly by the user.
|
|
INLINE void win_display_regions_changed();
|
|
INLINE bool needs_context() const;
|
|
INLINE bool flip_ready() const;
|
|
|
|
INLINE bool operator < (const GraphicsOutput &other) const;
|
|
|
|
virtual GraphicsOutput *get_host();
|
|
|
|
virtual void request_open();
|
|
virtual void request_close();
|
|
|
|
virtual void set_close_now();
|
|
virtual void reset_window(bool swapchain);
|
|
|
|
// It is an error to call any of the following methods from any
|
|
// thread other than the draw thread. These methods are normally
|
|
// called by the GraphicsEngine.
|
|
virtual bool begin_frame();
|
|
void clear();
|
|
virtual void end_frame();
|
|
|
|
// This method is called in the draw thread prior to issuing any
|
|
// drawing commands for the window.
|
|
virtual bool make_context();
|
|
virtual void make_current();
|
|
virtual void release_gsg();
|
|
|
|
// These methods will be called within the app (main) thread.
|
|
virtual void begin_flip();
|
|
virtual void end_flip();
|
|
|
|
// It is an error to call any of the following methods from any
|
|
// thread other than the window thread. These methods are normally
|
|
// called by the GraphicsEngine.
|
|
virtual void process_events();
|
|
|
|
protected:
|
|
void declare_channel(int index, GraphicsChannel *chan);
|
|
void setup_copy_texture(const string &name);
|
|
|
|
protected:
|
|
PT(GraphicsStateGuardian) _gsg;
|
|
PT(GraphicsPipe) _pipe;
|
|
string _name;
|
|
PT(Texture) _texture;
|
|
bool _copy_texture;
|
|
bool _flip_ready;
|
|
bool _needs_context;
|
|
|
|
private:
|
|
INLINE void determine_display_regions() const;
|
|
void do_determine_display_regions();
|
|
|
|
int _sort;
|
|
|
|
protected:
|
|
Mutex _lock;
|
|
// protects _channels, _display_regions.
|
|
|
|
typedef pvector< PT(GraphicsChannel) > Channels;
|
|
Channels _channels;
|
|
|
|
typedef pvector<DisplayRegion *> DisplayRegions;
|
|
DisplayRegions _display_regions;
|
|
bool _display_regions_stale;
|
|
|
|
protected:
|
|
int _x_size;
|
|
int _y_size;
|
|
bool _has_size;
|
|
bool _is_valid;
|
|
|
|
static PStatCollector _make_current_pcollector;
|
|
static PStatCollector _copy_texture_pcollector;
|
|
|
|
public:
|
|
static TypeHandle get_class_type() {
|
|
return _type_handle;
|
|
}
|
|
static void init_type() {
|
|
TypedWritableReferenceCount::init_type();
|
|
register_type(_type_handle, "GraphicsOutput",
|
|
TypedWritableReferenceCount::get_class_type());
|
|
}
|
|
virtual TypeHandle get_type() const {
|
|
return get_class_type();
|
|
}
|
|
virtual TypeHandle force_init_type() {init_type(); return get_class_type();}
|
|
|
|
private:
|
|
static TypeHandle _type_handle;
|
|
|
|
friend class GraphicsPipe;
|
|
friend class GraphicsEngine;
|
|
};
|
|
|
|
#include "graphicsOutput.I"
|
|
|
|
#endif /* GRAPHICSOUTPUT_H */
|