Panda3D
Public Member Functions | Static Public Member Functions
DisplayRegionPipelineReader Class Reference

Encapsulates the data from a DisplayRegion, pre-fetched for one stage of the pipeline. More...

#include "displayRegion.h"

List of all members.

Public Member Functions

 DisplayRegionPipelineReader (DisplayRegion *object, Thread *current_thread)
PN_stdfloat get_bottom () const
 Retrieves the y coordinate of the bottom edge of the rectangle within its GraphicsOutput.
NodePath get_camera () const
 Returns the camera associated with this DisplayRegion, or an empty NodePath if no camera is associated.
bool get_clear_depth_between_eyes () const
int get_cube_map_index () const
 Returns the cube map face index associated with this particular DisplayRegion, or -1 if it is not associated with a cube map.
Threadget_current_thread () const
void get_dimensions (PN_stdfloat &l, PN_stdfloat &r, PN_stdfloat &b, PN_stdfloat &t) const
 Retrieves the coordinates of the DisplayRegion's rectangle within its GraphicsOutput.
const LVecBase4get_dimensions () const
 Retrieves the coordinates of the DisplayRegion's rectangle within its GraphicsOutput.
CallbackObjectget_draw_callback () const
 Returns the CallbackObject set by set_draw_callback().
PN_stdfloat get_left () const
 Retrieves the x coordinate of the left edge of the rectangle within its GraphicsOutput.
int get_lens_index () const
 Gets the index into a lens_node lens array.
DisplayRegionget_object () const
GraphicsPipeget_pipe () const
 Returns the GraphicsPipe that this DisplayRegion is ultimately associated with, or NULL if no pipe is associated.
int get_pixel_height () const
 Returns the height of the DisplayRegion in pixels.
int get_pixel_width () const
 Returns the width of the DisplayRegion in pixels.
void get_pixels (int &pl, int &pr, int &pb, int &pt) const
 Retrieves the coordinates of the DisplayRegion within its window, in pixels.
void get_region_pixels (int &xo, int &yo, int &w, int &h) const
 Retrieves the coordinates of the DisplayRegion within its window, as the pixel location of its bottom-left corner, along with a pixel width and height.
void get_region_pixels_i (int &xo, int &yo, int &w, int &h) const
 Similar to get_region_pixels(), but returns the upper left corner, and the pixel numbers are numbered from the top-left corner down, in the DirectX way of things.
PN_stdfloat get_right () const
 Retrieves the x coordinate of the right edge of the rectangle within its GraphicsOutput.
int get_sort () const
 Returns the sort value associated with the DisplayRegion.
Lens::StereoChannel get_stereo_channel () const
 Returns whether the DisplayRegion is specified as the left or right channel of a stereo pair, or whether it is a normal, monocular image.
int get_tex_view_offset ()
 Returns the current texture view offset for this DisplayRegion.
PN_stdfloat get_top () const
 Retrieves the y coordinate of the top edge of the rectangle within its GraphicsOutput.
GraphicsOutputget_window () const
 Returns the GraphicsOutput that this DisplayRegion is ultimately associated with, or NULL if no window is associated.
bool is_active () const
 Returns the active flag associated with the DisplayRegion.
bool is_any_clear_active () const

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()

Detailed Description

Encapsulates the data from a DisplayRegion, pre-fetched for one stage of the pipeline.

Definition at line 279 of file displayRegion.h.


Member Function Documentation

PN_stdfloat DisplayRegionPipelineReader::get_bottom ( ) const [inline]

Retrieves the y coordinate of the bottom edge of the rectangle within its GraphicsOutput.

This number will be in the range [0..1].

Definition at line 685 of file displayRegion.I.

Returns the camera associated with this DisplayRegion, or an empty NodePath if no camera is associated.

Definition at line 721 of file displayRegion.I.

Returns the cube map face index associated with this particular DisplayRegion, or -1 if it is not associated with a cube map.

See set_cube_map_index().

Definition at line 787 of file displayRegion.I.

Referenced by GraphicsOutput::change_scenes().

void DisplayRegionPipelineReader::get_dimensions ( PN_stdfloat &  l,
PN_stdfloat &  r,
PN_stdfloat &  b,
PN_stdfloat &  t 
) const [inline]

Retrieves the coordinates of the DisplayRegion's rectangle within its GraphicsOutput.

These numbers will be in the range [0..1].

Definition at line 634 of file displayRegion.I.

Retrieves the coordinates of the DisplayRegion's rectangle within its GraphicsOutput.

These numbers will be in the range [0..1].

Definition at line 649 of file displayRegion.I.

Returns the CallbackObject set by set_draw_callback().

Definition at line 797 of file displayRegion.I.

PN_stdfloat DisplayRegionPipelineReader::get_left ( ) const [inline]

Retrieves the x coordinate of the left edge of the rectangle within its GraphicsOutput.

This number will be in the range [0..1].

Definition at line 661 of file displayRegion.I.

Gets the index into a lens_node lens array.

0 default

Definition at line 862 of file displayRegion.I.

Returns the GraphicsPipe that this DisplayRegion is ultimately associated with, or NULL if no pipe is associated.

Definition at line 876 of file displayRegion.cxx.

References GraphicsOutput::get_pipe().

Returns the height of the DisplayRegion in pixels.

Definition at line 873 of file displayRegion.I.

Returns the width of the DisplayRegion in pixels.

Definition at line 852 of file displayRegion.I.

void DisplayRegionPipelineReader::get_pixels ( int &  pl,
int &  pr,
int &  pb,
int &  pt 
) const [inline]

Retrieves the coordinates of the DisplayRegion within its window, in pixels.

Definition at line 808 of file displayRegion.I.

void DisplayRegionPipelineReader::get_region_pixels ( int &  xo,
int &  yo,
int &  w,
int &  h 
) const [inline]

Retrieves the coordinates of the DisplayRegion within its window, as the pixel location of its bottom-left corner, along with a pixel width and height.

Definition at line 823 of file displayRegion.I.

void DisplayRegionPipelineReader::get_region_pixels_i ( int &  xo,
int &  yo,
int &  w,
int &  h 
) const [inline]

Similar to get_region_pixels(), but returns the upper left corner, and the pixel numbers are numbered from the top-left corner down, in the DirectX way of things.

Definition at line 839 of file displayRegion.I.

Referenced by TinyGraphicsStateGuardian::prepare_display_region(), DXGraphicsStateGuardian8::prepare_display_region(), and DXGraphicsStateGuardian9::prepare_display_region().

PN_stdfloat DisplayRegionPipelineReader::get_right ( ) const [inline]

Retrieves the x coordinate of the right edge of the rectangle within its GraphicsOutput.

This number will be in the range [0..1].

Definition at line 673 of file displayRegion.I.

int DisplayRegionPipelineReader::get_sort ( ) const [inline]

Returns the sort value associated with the DisplayRegion.

Definition at line 743 of file displayRegion.I.

Lens::StereoChannel DisplayRegionPipelineReader::get_stereo_channel ( ) const [inline]

Returns whether the DisplayRegion is specified as the left or right channel of a stereo pair, or whether it is a normal, monocular image.

See set_stereo_channel().

Definition at line 756 of file displayRegion.I.

Referenced by GraphicsStateGuardian::prepare_display_region().

Returns the current texture view offset for this DisplayRegion.

This is normally set to zero. If nonzero, it is used to select a particular view of any multiview textures that are rendered within this DisplayRegion.

For a StereoDisplayRegion, this is normally 0 for the left eye, and 1 for the right eye, to support stereo textures.

Definition at line 774 of file displayRegion.I.

Referenced by GraphicsStateGuardian::prepare_display_region().

PN_stdfloat DisplayRegionPipelineReader::get_top ( ) const [inline]

Retrieves the y coordinate of the top edge of the rectangle within its GraphicsOutput.

This number will be in the range [0..1].

Definition at line 697 of file displayRegion.I.

Returns the GraphicsOutput that this DisplayRegion is ultimately associated with, or NULL if no window is associated.

Definition at line 709 of file displayRegion.I.

Referenced by GraphicsStateGuardian::prepare_display_region().

bool DisplayRegionPipelineReader::is_active ( ) const [inline]

Returns the active flag associated with the DisplayRegion.

Definition at line 732 of file displayRegion.I.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations