synfig::RendDesc Class Reference

#include <renddesc.h>

List of all members.

Public Types

enum  Lock {
  PX_ASPECT = (1<<0), PX_AREA = (1<<1), PX_W = (1<<2), PX_H = (1<<3),
  IM_ASPECT = (1<<4), IM_SPAN = (1<<5), IM_W = (1<<6), IM_H = (1<<7),
  IM_ZOOMIN = (1<<8), IM_ZOOMOUT = (1<<9), LINK_PX_ASPECT = (1<<10), LINK_PX_AREA = (1<<11),
  LINK_IM_ASPECT = (1<<12), LINK_IM_SPAN = (1<<13), LINK_IM_CENTER = (1<<14)
}
enum  {
  ANTIALIAS_UNIFORM, ANTIALIAS_MONTE_CARLO, ANTIALIAS_JITTERED, ANTIALIAS_ADAPTIVE,
  ANTIALIAS_QUINTCUNX
}

Public Member Functions

 RendDesc ()
 Default Constructor.
RendDescapply (const RendDesc &x)
const Colorget_bg_color () const
RendDescset_bg_color (const Color &bg)
int get_w () const
 Return the width of the composition in pixels.
RendDescset_w (int x)
 Set the width of the composition in pixels.
int get_h () const
 Return the height of the composition in pixels.
RendDescset_h (int y)
 Set the height of the composition in pixels.
RendDescset_wh (int x, int y)
 Sets the width and height of the composition in pixels.
Real get_x_res () const
 Returns the horizontal resolution (in dots per meter).
RendDescset_x_res (Real x)
 Sets the horizontal resolution (in dots per meter).
Real get_y_res () const
 Returns the vertical resolution (in dots per meter).
RendDescset_y_res (Real y)
 Sets the vertical resolution (in dots per meter).
Real get_physical_w () const
 Return the physical width of the composition in meters.
Real get_physical_h () const
 Return the physical height of the composition in meters.
RendDescset_physical_w (Real w)
 Set the physical width of the composition in meters.
RendDescset_physical_h (Real h)
 Set the physical height of the composition in meters.
int get_frame_start () const
 Return the index of the first frame.
RendDescset_frame_start (int x)
 Set the index of the first frame.
int get_frame_end () const
 Return the index of the last frame.
RendDescset_frame_end (int x)
 Set the index of the last frame.
const Time get_time_start () const
 Return the starting time of the animation.
RendDescset_time_start (Time x)
 Set the time that the animation will start.
const Time get_time_end () const
 Return the end time of the animation.
RendDescset_time_end (Time x)
 Set the time that the animation will end.
RendDescset_time (Time x)
 Setup for one frame at the given time.
RendDescset_frame (int x)
 Setup for one frame.
const float & get_frame_rate () const
 Return the frame rate (frames-per-second).
RendDescset_frame_rate (float x)
 Set the frame rate (frames-per-second).
const bool & get_interlaced () const
 Return the status of the interlaced flag.
RendDescset_interlaced (bool x)
 Set the interlace flag.
const bool & get_clamp () const
 Return the status of the clamp flag.
RendDescset_clamp (bool x)
 Set the clamp flag.
RendDescset_flags (const int &x)
 Set constraint flags.
RendDescclear_flags ()
 Clear constraint flags.
int get_flags () const
 Get constraint flags.
Point::value_type get_pixel_aspect () const
 Return the aspect ratio of a single pixel.
Point::value_type get_image_aspect () const
 Return the aspect ratio of the entire image.
const int & get_antialias () const
 Return the antialias amount.
RendDescset_antialias (const int &x)
 Set the antialias amount.
Real get_span () const
 Return the distance from the bottom-right to the top-left.
RendDescset_span (const Real &x)
 Set the span distance.
const Pointget_focus () const
RendDescset_focus (const Point &x)
const Pointget_tl () const
RendDescset_tl (const Point &x)
const Pointget_br () const
RendDescset_br (const Point &x)
Rect get_rect () const
RendDescset_viewport (const Point &__tl, const Point &__br)
RendDescset_viewport (Vector::value_type a, Vector::value_type b, Vector::value_type c, Vector::value_type d)
Real get_pw () const
 Returns the width of one pixel.
Real get_ph () const
 Returns the height of one pixel.
RendDescset_subwindow (int x, int y, int w, int h)
 Sets viewport to represent the screen at the given pixel coordinates.

Public Attributes

enum synfig::RendDesc:: { ... }  AntialiasFilter


Detailed Description

Todo:
writeme

Member Enumeration Documentation

Enumerator:
PX_ASPECT 
PX_AREA 
PX_W 
PX_H 
IM_ASPECT 
IM_SPAN 
IM_W 
IM_H 
IM_ZOOMIN 
IM_ZOOMOUT 
LINK_PX_ASPECT 
LINK_PX_AREA 
LINK_IM_ASPECT 
LINK_IM_SPAN 
LINK_IM_CENTER 

anonymous enum

Enumerator:
ANTIALIAS_UNIFORM 
ANTIALIAS_MONTE_CARLO 
ANTIALIAS_JITTERED 
ANTIALIAS_ADAPTIVE 
ANTIALIAS_QUINTCUNX 


Constructor & Destructor Documentation

synfig::RendDesc::RendDesc (  )  [inline]

Default Constructor.

References f.


Member Function Documentation

RendDesc & RendDesc::apply ( const RendDesc x  ) 

Todo:
This needs to be documented further.

const Color & RendDesc::get_bg_color (  )  const

Todo:
This needs to be documented further.

Referenced by synfig::Target_Scanline::add_frame(), encode_canvas(), and synfig::Target_Scanline::render().

RendDesc & RendDesc::set_bg_color ( const Color bg  ) 

Todo:
This needs to be documented further.

int RendDesc::get_w (  )  const

Return the width of the composition in pixels.

Referenced by Warp::accelerated_render(), SuperSample::accelerated_render(), synfig::Layer_Stretch::accelerated_render(), SpiralGradient::accelerated_render(), synfig::Layer_SphereDistort::accelerated_render(), Layer_Shade::accelerated_render(), Rotate::accelerated_render(), Rectangle::accelerated_render(), RadialGradient::accelerated_render(), RadialBlur::accelerated_render(), Plant::accelerated_render(), Noise::accelerated_render(), Metaballs::accelerated_render(), Layer_Freetype::accelerated_render(), LumaKey::accelerated_render(), LinearGradient::accelerated_render(), synfig::Layer_SolidColor::accelerated_render(), synfig::Layer_Shape::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), synfig::Layer_MotionBlur::accelerated_render(), synfig::Layer_Duplicate::accelerated_render(), synfig::Layer_Bitmap::accelerated_render(), FilledRect::accelerated_render(), CurveWarp::accelerated_render(), CurveGradient::accelerated_render(), synfig::Context::accelerated_render(), ConicalGradient::accelerated_render(), synfig::Layer_ColorCorrect::accelerated_render(), synfig::Layer_Clamp::accelerated_render(), Circle::accelerated_render(), Blur_Layer::accelerated_render(), Layer_Bevel::accelerated_render(), encode_canvas(), yuv::end_frame(), exr_trgt::end_frame(), gif::end_frame(), ppm::end_scanline(), png_trgt::end_scanline(), exr_trgt::end_scanline(), mng_trgt::end_scanline(), jpeg_trgt::end_scanline(), imagemagick_trgt::end_scanline(), ffmpeg_trgt::end_scanline(), dv_trgt::end_scanline(), bmp::end_scanline(), synfig::Target_Multi::end_scanline(), extract_RendDesc(), get_physical_w(), yuv::init(), mng_trgt::init(), magickpp_trgt::init(), imagemagick_trgt::init(), gif::init(), synfig::parametric_render(), synfig::Target_Scanline::render(), synfig::render(), synfig::render_threaded(), yuv::set_rend_desc(), bsd_mpeg1::set_rend_desc(), ffmpeg_trgt::set_rend_desc(), Target_LibAVCodec::set_rend_desc(), ppm::start_frame(), png_trgt::start_frame(), exr_trgt::start_frame(), jpeg_trgt::start_frame(), imagemagick_trgt::start_frame(), ffmpeg_trgt::start_frame(), dv_trgt::start_frame(), bmp::start_frame(), and synfig::Target_Null::start_frame().

RendDesc & RendDesc::set_w ( int  x  ) 

Set the width of the composition in pixels.

The other parameters are adjusted according to the constraints placed on the flags.

Todo:
This needs to be documented further.

Todo:
This needs to be documented further.

References FLAGS, get_span(), IM_SPAN, IM_W, IM_ZOOMIN, IM_ZOOMOUT, LINK_PX_AREA, LINK_PX_ASPECT, PX_AREA, PX_ASPECT, and set_span().

Referenced by set_physical_w(), yuv::set_rend_desc(), bsd_mpeg1::set_rend_desc(), ffmpeg_trgt::set_rend_desc(), Target_LibAVCodec::set_rend_desc(), and set_wh().

int RendDesc::get_h (  )  const

Return the height of the composition in pixels.

Referenced by Warp::accelerated_render(), SuperSample::accelerated_render(), synfig::Layer_Stretch::accelerated_render(), SpiralGradient::accelerated_render(), synfig::Layer_SphereDistort::accelerated_render(), Layer_Shade::accelerated_render(), Rotate::accelerated_render(), Rectangle::accelerated_render(), RadialGradient::accelerated_render(), RadialBlur::accelerated_render(), Plant::accelerated_render(), Noise::accelerated_render(), Metaballs::accelerated_render(), Layer_Freetype::accelerated_render(), LumaKey::accelerated_render(), LinearGradient::accelerated_render(), synfig::Layer_SolidColor::accelerated_render(), synfig::Layer_Shape::accelerated_render(), synfig::Layer_PasteCanvas::accelerated_render(), synfig::Layer_MotionBlur::accelerated_render(), synfig::Layer_Duplicate::accelerated_render(), synfig::Layer_Bitmap::accelerated_render(), FilledRect::accelerated_render(), CurveWarp::accelerated_render(), CurveGradient::accelerated_render(), synfig::Context::accelerated_render(), ConicalGradient::accelerated_render(), synfig::Layer_ColorCorrect::accelerated_render(), synfig::Layer_Clamp::accelerated_render(), Circle::accelerated_render(), Blur_Layer::accelerated_render(), Layer_Bevel::accelerated_render(), encode_canvas(), yuv::end_frame(), exr_trgt::end_frame(), gif::end_frame(), extract_RendDesc(), get_physical_h(), yuv::init(), mng_trgt::init(), magickpp_trgt::init(), gif::init(), synfig::parametric_render(), synfig::Target_Scanline::render(), synfig::render(), synfig::render_threaded(), yuv::set_rend_desc(), bsd_mpeg1::set_rend_desc(), ffmpeg_trgt::set_rend_desc(), Target_LibAVCodec::set_rend_desc(), ppm::start_frame(), png_trgt::start_frame(), exr_trgt::start_frame(), jpeg_trgt::start_frame(), imagemagick_trgt::start_frame(), ffmpeg_trgt::start_frame(), dv_trgt::start_frame(), and bmp::start_frame().

RendDesc & RendDesc::set_h ( int  y  ) 

Set the height of the composition in pixels.

The other parameters are adjusted according to the constraints placed on the flags.

Todo:
This needs to be documented further.

Todo:
This needs to be documented further.

References FLAGS, get_span(), IM_SPAN, IM_W, IM_ZOOMIN, IM_ZOOMOUT, LINK_PX_AREA, LINK_PX_ASPECT, PX_AREA, PX_ASPECT, and set_span().

Referenced by set_physical_h(), yuv::set_rend_desc(), bsd_mpeg1::set_rend_desc(), ffmpeg_trgt::set_rend_desc(), Target_LibAVCodec::set_rend_desc(), and set_wh().

RendDesc & RendDesc::set_wh ( int  x,
int  y 
)

Real RendDesc::get_x_res (  )  const

RendDesc & RendDesc::set_x_res ( Real  x  ) 

Sets the horizontal resolution (in dots per meter).

Referenced by extract_RendDesc().

Real RendDesc::get_y_res (  )  const

Returns the vertical resolution (in dots per meter).

Referenced by encode_canvas(), get_physical_h(), mng_trgt::init(), set_physical_h(), png_trgt::start_frame(), and imagemagick_trgt::start_frame().

RendDesc & RendDesc::set_y_res ( Real  y  ) 

Sets the vertical resolution (in dots per meter).

Referenced by extract_RendDesc().

Real RendDesc::get_physical_w (  )  const

Return the physical width of the composition in meters.

References get_w(), and get_x_res().

Real RendDesc::get_physical_h (  )  const

Return the physical height of the composition in meters.

References get_h(), and get_y_res().

RendDesc & RendDesc::set_physical_w ( Real  w  ) 

Set the physical width of the composition in meters.

References get_x_res(), and set_w().

RendDesc & RendDesc::set_physical_h ( Real  h  ) 

Set the physical height of the composition in meters.

References get_y_res(), and set_h().

int RendDesc::get_frame_start (  )  const

RendDesc & RendDesc::set_frame_start ( int  x  ) 

Set the index of the first frame.

References set_time_start().

int RendDesc::get_frame_end (  )  const

RendDesc & RendDesc::set_frame_end ( int  x  ) 

const Time RendDesc::get_time_start (  )  const

RendDesc & RendDesc::set_time_start ( Time  x  ) 

Set the time that the animation will start.

Referenced by extract_RendDesc(), and set_frame_start().

const Time RendDesc::get_time_end (  )  const

RendDesc & RendDesc::set_time_end ( Time  x  ) 

Set the time that the animation will end.

Referenced by extract_RendDesc(), and set_frame_end().

RendDesc & RendDesc::set_time ( Time  x  ) 

Setup for one frame at the given time.

Referenced by extract_RendDesc(), and set_frame().

RendDesc & RendDesc::set_frame ( int  x  ) 

Setup for one frame.

References set_time().

const float & RendDesc::get_frame_rate (  )  const

RendDesc & RendDesc::set_frame_rate ( float  x  ) 

const bool & RendDesc::get_interlaced (  )  const

Return the status of the interlaced flag.

RendDesc & RendDesc::set_interlaced ( bool  x  ) 

Set the interlace flag.

Referenced by dv_trgt::set_rend_desc().

const bool & RendDesc::get_clamp (  )  const

Return the status of the clamp flag.

Referenced by synfig::parametric_render(), synfig::render(), and synfig::render_threaded().

RendDesc & RendDesc::set_clamp ( bool  x  ) 

Set the clamp flag.

RendDesc & RendDesc::set_flags ( const int &  x  ) 

RendDesc & RendDesc::clear_flags (  ) 

int RendDesc::get_flags (  )  const

Get constraint flags.

Real RendDesc::get_pixel_aspect (  )  const

Return the aspect ratio of a single pixel.

Referenced by exr_trgt::start_frame().

Real RendDesc::get_image_aspect (  )  const

Return the aspect ratio of the entire image.

const int & RendDesc::get_antialias (  )  const

Return the antialias amount.

Referenced by encode_canvas(), synfig::parametric_render(), synfig::render(), and synfig::render_threaded().

RendDesc & RendDesc::set_antialias ( const int &  x  ) 

Set the antialias amount.

Referenced by extract_RendDesc().

Real RendDesc::get_span (  )  const

Return the distance from the bottom-right to the top-left.

Referenced by set_h(), set_span(), and set_w().

RendDesc & RendDesc::set_span ( const Real x  ) 

Set the span distance.

Todo:
this looks wrong. I suspect the intention was to check

Todo:
This needs to be documented further. or fix me

Todo:
This needs to be documented further. or fix me

References FLAGS, get_span(), IM_ASPECT, IM_H, and IM_W.

Referenced by extract_RendDesc(), set_h(), and set_w().

const Point & RendDesc::get_focus (  )  const

RendDesc & RendDesc::set_focus ( const Point x  ) 

const Point & RendDesc::get_tl (  )  const

RendDesc & RendDesc::set_tl ( const Point x  ) 

const Point & RendDesc::get_br (  )  const

RendDesc & RendDesc::set_br ( const Point x  ) 

Rect synfig::RendDesc::get_rect (  )  const [inline]

RendDesc & RendDesc::set_viewport ( const Point __tl,
const Point __br 
)

RendDesc & RendDesc::set_viewport ( Vector::value_type  a,
Vector::value_type  b,
Vector::value_type  c,
Vector::value_type  d 
)

Real RendDesc::get_pw (  )  const

Real RendDesc::get_ph (  )  const

RendDesc & RendDesc::set_subwindow ( int  x,
int  y,
int  w,
int  h 
)


Member Data Documentation


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

Generated on Fri Jul 31 00:01:59 2009 for synfig-core by  doxygen 1.5.6