Panda3D
Public Member Functions | Static Public Member Functions | List of all members
DisplayRegionPipelineReader Class Reference

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

#include "displayRegion.h"

Public Member Functions

 DisplayRegionPipelineReader (DisplayRegion *object, Thread *current_thread)
 
PN_stdfloat get_bottom (int i=0) const
 Retrieves the y coordinate of the bottom edge of the rectangle within its GraphicsOutput. More...
 
NodePath get_camera () const
 Returns the camera associated with this DisplayRegion, or an empty NodePath if no camera is associated. More...
 
bool get_clear_depth_between_eyes () const
 
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. More...
 
void get_dimensions (int i, PN_stdfloat &l, PN_stdfloat &r, PN_stdfloat &b, PN_stdfloat &t) const
 Retrieves the coordinates of the DisplayRegion's rectangle within its GraphicsOutput. More...
 
const LVecBase4get_dimensions (int i=0) const
 Retrieves the coordinates of the DisplayRegion's rectangle within its GraphicsOutput. More...
 
CallbackObjectget_draw_callback () const
 Returns the CallbackObject set by set_draw_callback(). More...
 
PN_stdfloat get_left (int i=0) const
 Retrieves the x coordinate of the left edge of the rectangle within its GraphicsOutput. More...
 
int get_lens_index () const
 Gets the index into a lens_node lens array. More...
 
int get_num_regions () const
 Returns the number of regions, see set_num_regions. More...
 
DisplayRegionget_object () const
 
GraphicsPipeget_pipe () const
 Returns the GraphicsPipe that this DisplayRegion is ultimately associated with, or NULL if no pipe is associated. More...
 
int get_pixel_height (int i=0) const
 Returns the height of the DisplayRegion in pixels. More...
 
int get_pixel_width (int i=0) const
 Returns the width of the DisplayRegion in pixels. More...
 
void get_pixels (int &pl, int &pr, int &pb, int &pt) const
 Retrieves the coordinates of the DisplayRegion within its window, in pixels. More...
 
void get_pixels (int i, int &pl, int &pr, int &pb, int &pt) const
 Retrieves the coordinates of the DisplayRegion within its window, in pixels. More...
 
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. More...
 
void get_region_pixels (int i, 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. More...
 
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. More...
 
void get_region_pixels_i (int 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. More...
 
PN_stdfloat get_right (int i=0) const
 Retrieves the x coordinate of the right edge of the rectangle within its GraphicsOutput. More...
 
bool get_scissor_enabled () const
 Returns whether or not scissor testing is enabled for this region. More...
 
int get_sort () const
 Returns the sort value associated with the DisplayRegion. More...
 
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. More...
 
int get_target_tex_page () const
 Returns the target page number associated with this particular DisplayRegion, or -1 if it is not associated with a page. More...
 
int get_tex_view_offset ()
 Returns the current texture view offset for this DisplayRegion. More...
 
PN_stdfloat get_top (int i=0) const
 Retrieves the y coordinate of the top edge of the rectangle within its GraphicsOutput. More...
 
GraphicsOutputget_window () const
 Returns the GraphicsOutput that this DisplayRegion is ultimately associated with, or NULL if no window is associated. More...
 
bool is_active () const
 Returns the active flag associated with the DisplayRegion. More...
 
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 296 of file displayRegion.h.

Member Function Documentation

◆ get_bottom()

PN_stdfloat DisplayRegionPipelineReader::get_bottom ( int  i = 0) 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 864 of file displayRegion.I.

References get_top().

Referenced by get_right().

◆ get_camera()

NodePath DisplayRegionPipelineReader::get_camera ( ) const
inline

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

Definition at line 900 of file displayRegion.I.

References is_active().

Referenced by GraphicsEngine::do_cull(), and get_window().

◆ get_dimensions() [1/3]

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 800 of file displayRegion.I.

References DisplayRegion::get_dimensions().

Referenced by get_dimensions(), and get_num_regions().

◆ get_dimensions() [2/3]

void DisplayRegionPipelineReader::get_dimensions ( int  i,
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 812 of file displayRegion.I.

References get_dimensions().

◆ get_dimensions() [3/3]

const LVecBase4 & DisplayRegionPipelineReader::get_dimensions ( int  i = 0) 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 828 of file displayRegion.I.

References get_left().

◆ get_draw_callback()

CallbackObject * DisplayRegionPipelineReader::get_draw_callback ( ) const
inline

Returns the CallbackObject set by set_draw_callback().

Definition at line 988 of file displayRegion.I.

References get_pixels().

Referenced by GraphicsEngine::do_cull(), and get_scissor_enabled().

◆ get_left()

PN_stdfloat DisplayRegionPipelineReader::get_left ( int  i = 0) 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 840 of file displayRegion.I.

References get_right().

Referenced by get_dimensions().

◆ get_lens_index()

int DisplayRegionPipelineReader::get_lens_index ( ) const
inline

Gets the index into a lens_node lens array.

0 default

Definition at line 1092 of file displayRegion.I.

References get_pixel_height().

Referenced by GraphicsEngine::do_cull(), and get_pixel_width().

◆ get_num_regions()

int DisplayRegionPipelineReader::get_num_regions ( ) const
inline

Returns the number of regions, see set_num_regions.

Definition at line 788 of file displayRegion.I.

References get_dimensions().

Referenced by DisplayRegion::get_draw_region_pcollector().

◆ get_pipe()

GraphicsPipe * DisplayRegionPipelineReader::get_pipe ( ) const

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

Definition at line 895 of file displayRegion.cxx.

Referenced by DisplayRegion::supports_pixel_zoom().

◆ get_pixel_height()

int DisplayRegionPipelineReader::get_pixel_height ( int  i = 0) const
inline

Returns the height of the DisplayRegion in pixels.

Definition at line 1102 of file displayRegion.I.

Referenced by GraphicsEngine::do_cull(), and get_lens_index().

◆ get_pixel_width()

int DisplayRegionPipelineReader::get_pixel_width ( int  i = 0) const
inline

Returns the width of the DisplayRegion in pixels.

Definition at line 1082 of file displayRegion.I.

References get_lens_index().

Referenced by GraphicsEngine::do_cull(), and get_region_pixels_i().

◆ get_pixels() [1/2]

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 999 of file displayRegion.I.

References DisplayRegion::get_pixels().

Referenced by get_draw_callback().

◆ get_pixels() [2/2]

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

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

Definition at line 1010 of file displayRegion.I.

References get_region_pixels().

◆ get_region_pixels() [1/2]

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 1026 of file displayRegion.I.

References DisplayRegion::get_region_pixels().

Referenced by get_pixels().

◆ get_region_pixels() [2/2]

void DisplayRegionPipelineReader::get_region_pixels ( int  i,
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 1038 of file displayRegion.I.

References get_region_pixels_i().

◆ get_region_pixels_i() [1/2]

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 1055 of file displayRegion.I.

References DisplayRegion::get_region_pixels_i().

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

◆ get_region_pixels_i() [2/2]

void DisplayRegionPipelineReader::get_region_pixels_i ( int  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 1068 of file displayRegion.I.

References get_pixel_width().

◆ get_right()

PN_stdfloat DisplayRegionPipelineReader::get_right ( int  i = 0) 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 852 of file displayRegion.I.

References get_bottom().

Referenced by get_left().

◆ get_scissor_enabled()

bool DisplayRegionPipelineReader::get_scissor_enabled ( ) const
inline

Returns whether or not scissor testing is enabled for this region.

The default is true, except for the overlay display region.

Definition at line 978 of file displayRegion.I.

References get_draw_callback().

Referenced by get_target_tex_page().

◆ get_sort()

int DisplayRegionPipelineReader::get_sort ( ) const
inline

Returns the sort value associated with the DisplayRegion.

Definition at line 922 of file displayRegion.I.

References get_stereo_channel().

Referenced by is_active().

◆ get_stereo_channel()

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 935 of file displayRegion.I.

References get_tex_view_offset().

Referenced by get_sort(), and GraphicsStateGuardian::prepare_display_region().

◆ get_target_tex_page()

int DisplayRegionPipelineReader::get_target_tex_page ( ) const
inline

Returns the target page number associated with this particular DisplayRegion, or -1 if it is not associated with a page.

See set_target_tex_page().

Definition at line 966 of file displayRegion.I.

References get_scissor_enabled().

Referenced by GraphicsOutput::change_scenes(), and get_tex_view_offset().

◆ get_tex_view_offset()

int DisplayRegionPipelineReader::get_tex_view_offset ( )
inline

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 953 of file displayRegion.I.

References get_target_tex_page().

Referenced by get_stereo_channel(), and GraphicsStateGuardian::prepare_display_region().

◆ get_top()

PN_stdfloat DisplayRegionPipelineReader::get_top ( int  i = 0) 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 876 of file displayRegion.I.

References get_window().

Referenced by get_bottom().

◆ get_window()

GraphicsOutput * DisplayRegionPipelineReader::get_window ( ) const
inline

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

Definition at line 888 of file displayRegion.I.

References get_camera().

Referenced by GraphicsEngine::do_cull(), get_top(), and GraphicsStateGuardian::prepare_display_region().

◆ is_active()

bool DisplayRegionPipelineReader::is_active ( ) const
inline

Returns the active flag associated with the DisplayRegion.

Definition at line 911 of file displayRegion.I.

References get_sort().

Referenced by get_camera().


The documentation for this class was generated from the following files: