# GraphicsPipe

from pandac.PandaModules import GraphicsPipe

Class : GraphicsPipe
Description : An object to create GraphicsOutputs that share a particular 3-D API. Normally, there will only be one GraphicsPipe in an application, although it is possible to have multiple of these at once if there are multiple different API's available in the same machine.
Often, the GraphicsPipe corresponds to a physical output device, hence the term "pipe", but this is not necessarily the case.
The GraphicsPipe is used by the GraphicsEngine object to create and destroy windows; it keeps ownership of the windows it creates.
M. Asad added new/interim functionality where GraphicsPipe now contains a device interface to directx/opengl which will be used to handle multiple windows from same device.

## Inheritance:

GraphicsPipe: TypedReferenceCount
TypedReferenceCount: TypedObject ReferenceCount
TypedObject: MemoryBase
MemoryBase:
ReferenceCount: MemoryBase

## Methods of GraphicsPipe:

getClassType
getDisplayHeight
getDisplayInformation
getDisplayWidth
getInterfaceName
getSupportedTypes
isValid
supportsType

## Methods of TypedReferenceCount:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

## Constants in GraphicsPipe:

OTWindow | (OutputTypes)
OTFullscreenWindow | (OutputTypes)
OTBuffer | (OutputTypes)
OTTextureBuffer | (OutputTypes)
BFRefuseParasite | (BufferCreationFlags)
BFRequireParasite | (BufferCreationFlags)
BFRefuseWindow | (BufferCreationFlags)
BFRequireWindow | (BufferCreationFlags)
BFCanBindColor | (BufferCreationFlags)
BFCanBindEvery | (BufferCreationFlags)
BFResizeable | (BufferCreationFlags)
BFSizeTrackHost | (BufferCreationFlags)
BFRttCumulative | (BufferCreationFlags)
BFFbPropsOptional | (BufferCreationFlags)
BFSizeSquare | (BufferCreationFlags)

getClassType static TypeHandle GraphicsPipe::get_class_type(void); Undocumented function.

getDisplayHeight int GraphicsPipe::get_display_height(void) const; Description: Returns the height of the entire display, if it is known. This may return 0. See the caveats for get_display_width().

getDisplayInformation DisplayInformation *GraphicsPipe::get_display_information(void); Description: Gets the pipe's DisplayInformation.

getDisplayWidth int GraphicsPipe::get_display_width(void) const; Description: Returns the width of the entire display, if it is known. This may return 0. This is not a guarantee that windows (particularly fullscreen windows) may not be created larger than this width, but it is intended to provide a hint to the application.

getInterfaceName virtual string GraphicsPipe::get_interface_name(void) const = 0; Undocumented function.

getSupportedTypes int GraphicsPipe::get_supported_types(void) const; Description: Returns the mask of bits that represents the kinds of GraphicsOutput objects this pipe might be able to successfully create. The return value is the union of bits in GraphicsPipe::OutputTypes that represents the set of GraphicsOutput types. A 1 bit in a particular position is not a guarantee of success, but a 0 bit is a guarantee of failure.

isValid bool GraphicsPipe::is_valid(void) const; Filename: graphicsPipe.I Created by: frang (07Mar99) 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 . Description: Returns false if this pipe is known to be invalid, meaning that an attempt to create a GraphicsWindow with the pipe will certainly fail. Returns true if the pipe is probably valid (is this case, an attempt to create a GraphicsWindow should succeed, but might still fail). Use the GraphicsEngine class to create a GraphicsWindow on a particular pipe.

supportsType bool GraphicsPipe::supports_type(int flags) const; Description: A convenience function to ask if a particular type or types of GraphicsObjects are supported. The parameter is a union of one or more bits defined in GrpahicsPipe::OutputTypes. Returns true if all of the requested types are listed in the supported_types mask, false if any one of them is not. This is not a guarantee that the indicated output type will successfully be created when it is attempted.

getClassType static TypeHandle TypedReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

isOfType bool TypedObject::is_of_type(TypeHandle handle) const; Description: Returns true if the current object is or derives from the indicated type.

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete(). User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it. The return value is true if the new reference count is nonzero, false if it is zero.