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

A class representing a region that has been rendered by an assigned host machine. The class holds the resulting image for the bounding region. More...

Inherits VRay.BucketRegion.

Public Member Functions

 BucketImage (int x, int y, int width, int height, String host, VRayImage image)
 Constructs a bucket region 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.BucketRegion
 BucketRegion (int x, int y, int width, int height, string host)
 Constructs a bucket region 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.RectRegion
 RectRegion (int x, int y, int width, int height)
 Constructs a rectangular region from the given arguments. Note: The (x, y) position represents the upper left coordinate of the matrix. More...
 

Properties

VRayImage Image [get]
 The rendered image for the given region.
 
- Properties inherited from VRay.BucketRegion
string Host [get, protected set]
 The name of the host that does the rendering for the bucket region.
 
- Properties inherited from VRay.RectRegion
int Height [get]
 Gets the actual height of the rendered bucket.
 
int Width [get]
 Gets the actual width of the rendered bucket.
 
int X [get]
 Gets the top left X coordinate of the rendered bucket.
 
int Y [get]
 Gets the top left Y coordinate of the rendered bucket.
 

Detailed Description

A class representing a region that has been rendered by an assigned host machine. The class holds the resulting image for the bounding region.

Constructor & Destructor Documentation

◆ BucketImage()

VRay.BucketImage.BucketImage ( int  x,
int  y,
int  width,
int  height,
String  host,
VRayImage  image 
)

Constructs a bucket region 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.

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