VRay SDK for C#
Loading...
Searching...
No Matches
VRay.BucketImageEventArgs Class Reference

A class representing a region that has finished its rendering pass. The class holds the resulting image for the bounding region. More...

Inherits VRay.BucketRegionEventArgs.

Public Member Functions

 BucketImageEventArgs (int x, int y, int width, int height, String host, VRayImage image, ImagePassType pass, double instant)
 Constructs bucket region event args from the given arguments. Note: The (x, y) position represents the upper left coordinate of the bucket matrix. More...
 
- Public Member Functions inherited from VRay.BucketRegionEventArgs
 BucketRegionEventArgs (int x, int y, int width, int height, string host, ImagePassType pass, double instant)
 Constructs bucket region event args from the given arguments. Note: The (x, y) position represents the upper left coordinate of the bucket matrix. More...
 
- Public Member Functions inherited from VRay.VRayEventArgs
 VRayEventArgs (double instant)
 Create a base event arg instance with timing info
 

Properties

VRayImage Image [get]
 The rendered image for the given region.
 
- Properties inherited from VRay.BucketRegionEventArgs
int Height [get]
 The actual height of the bucket.
 
string Host [get]
 The name of the host that does the rendering for the bucket region.
 
ImagePassType Pass [get]
 Which render pass generated this bucket
 
int Width [get]
 The actual width of the bucket.
 
int X [get]
 The top left X coordinate of the bucket.
 
int Y [get]
 The top left Y coordinate of the bucket.
 
- Properties inherited from VRay.VRayEventArgs
double Instant [get, set]
 Actual event time. Time is in seconds since V-Ray was initialized.
 

Detailed Description

A class representing a region that has finished its rendering pass. The class holds the resulting image for the bounding region.

Constructor & Destructor Documentation

◆ BucketImageEventArgs()

VRay.BucketImageEventArgs.BucketImageEventArgs ( int  x,
int  y,
int  width,
int  height,
String  host,
VRayImage  image,
ImagePassType  pass,
double  instant 
)

Constructs bucket region event args from the given arguments. Note: The (x, y) position represents the upper left coordinate of the bucket matrix.

Parameters
xThe top left X coordinate of the rendered bucket region.
yThe top left Y coordinate of the rendered bucket region.
widthThe actual width of the rendered bucket region.
heightThe actual height of the rendered bucket region.
hostThe name of the host that does the rendering for the bucket region.
imageThe rendered image.
passWhich render pass generated the image
instantThe actual time of ocurrence - seconds since V-Ray initialization

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