Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

panda/src/display/graphicsPipe.I

Go to the documentation of this file.
00001 // Filename: graphicsPipe.I
00002 // Created by:  frang (07Mar99)
00003 //
00004 ////////////////////////////////////////////////////////////////////
00005 //
00006 // PANDA 3D SOFTWARE
00007 // Copyright (c) 2001, Disney Enterprises, Inc.  All rights reserved
00008 //
00009 // All use of this software is subject to the terms of the Panda 3d
00010 // Software license.  You should have received a copy of this license
00011 // along with this source code; you will also find a current copy of
00012 // the license at http://www.panda3d.org/license.txt .
00013 //
00014 // To contact the maintainers of this program write to
00015 // panda3d@yahoogroups.com .
00016 //
00017 ////////////////////////////////////////////////////////////////////
00018 
00019 
00020 ////////////////////////////////////////////////////////////////////
00021 //     Function: GraphicsPipe::is_valid
00022 //       Access: Published
00023 //  Description: Returns false if this pipe is known to be invalid,
00024 //               meaning that an attempt to create a GraphicsWindow
00025 //               with the pipe will certainly fail.  Returns true if
00026 //               the pipe is probably valid (is this case, an attempt
00027 //               to create a GraphicsWindow should succeed, but might
00028 //               still fail).
00029 //
00030 //               Use the GraphicsEngine class to create a
00031 //               GraphicsWindow on a particular pipe.
00032 ////////////////////////////////////////////////////////////////////
00033 INLINE bool GraphicsPipe::
00034 is_valid() const {
00035   return _is_valid;
00036 }
00037 
00038 ////////////////////////////////////////////////////////////////////
00039 //     Function: GraphicsPipe::supports_fullscreen
00040 //       Access: Published
00041 //  Description: Returns false if this pipe is known to not support
00042 //               any creation of fullscreen windows.  If this returns
00043 //               false, any attempt to create a window with the
00044 //               fullscreen property set will certainly fail.
00045 //
00046 //               Returns true when the pipe will probably support
00047 //               fullscreen windows.  This is not, however, a
00048 //               guarantee that an attempt to create a fullscreen
00049 //               window will not fail.
00050 ////////////////////////////////////////////////////////////////////
00051 INLINE bool GraphicsPipe::
00052 supports_fullscreen() const {
00053   return _supports_fullscreen;
00054 }
00055 
00056 ////////////////////////////////////////////////////////////////////
00057 //     Function: GraphicsPipe::get_display_width
00058 //       Access: Public
00059 //  Description: Returns the width of the entire display, if it is
00060 //               known.  This may return 0.  This is not a guarantee
00061 //               that windows (particularly fullscreen windows) may
00062 //               not be created larger than this width, but it is
00063 //               intended to provide a hint to the application.
00064 ////////////////////////////////////////////////////////////////////
00065 INLINE int GraphicsPipe::
00066 get_display_width() const {
00067   return _display_width;
00068 }
00069 
00070 ////////////////////////////////////////////////////////////////////
00071 //     Function: GraphicsPipe::get_display_height
00072 //       Access: Public
00073 //  Description: Returns the height of the entire display, if it is
00074 //               known.  This may return 0.  See the caveats for
00075 //               get_display_width().
00076 ////////////////////////////////////////////////////////////////////
00077 INLINE int GraphicsPipe::
00078 get_display_height() const {
00079   return _display_height;
00080 }

Generated on Fri May 2 00:36:28 2003 for Panda by doxygen1.3