RenderWindow.Channel

References
public class RenderWindow.Channel : IDisposable

Properties

Height

#Since v7.0
public int Height { get; }
Return the channel height.

Id

#Since v7.0
public Guid Id { get; }
Return the channel id.

Width

#Since v7.0
public int Width { get; }
Return the channel width.

Methods

AddValue

#Since v6.0
public void AddValue(int x, int y, Color4f value)
Add value to existing values at point x, y. If x or y are out of range, the function will fail and may crash Rhino.
Parameters:
x (int)The horizontal pixel position. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer.
y (int)The vertical pixel position. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer.
value (Color4f)The color to store in the channel at the specified position.

Clone

#Since v7.0
public RenderWindow.Channel Clone()
Return a clone of the channel.

Dispose

#Since v5.0
public void Dispose()

Dispose

#
protected virtual void Dispose(bool disposing)
Parameters:
disposing (bool)

GetMinMaxValues

#Since v7.0
public void GetMinMaxValues(out float min, out float max)
Get the minimum and maximum values in the channel. minThe channel's minimum value. maxThe channel's maximum value.
Parameters:
min (out float)
max (out float)

GetValue

#Since v7.0
[CLSCompliant(false)] public void GetValue(int x, int y, ComponentOrders componentOrder, ref float[] values)
Get values from the channel.
Parameters:
x (int)
y (int)
componentOrder (ComponentOrders)
values (ref float[])

GetValues

#Since v7.0
public void GetValues(Rectangle rectangle, int stride, ComponentOrders componentOrder, ref float[] values)
Get a rectangle of values from the channel. The input parameters are checked for validity. If the rectangle is not fully inside the frame buffer, the function will fail.
Parameters:
rectangle (Rectangle)
stride (int)
componentOrder (ComponentOrders)
values (ref float[])

PixelSize

#Since v5.0
public int PixelSize()
Returns the size of the data in one pixel in the channel. For RDK standard channels, this value is always sizeof(float). For the special chanRGBA collective channel, this value is 4 * sizeof(float).
Returns: The size of a pixel.

SetValue

#Since v5.0
public void SetValue(int x, int y, Color4f value)
If x or y are out of range, the function will fail and may crash Rhino.
Parameters:
x (int)The horizontal pixel position. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer.
y (int)The vertical pixel position. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer.
value (Color4f)The color to store in the channel at the specified position.

SetValue

#Since v5.0
public void SetValue(int x, int y, float value)
Assign value to a pixel at coordinate (x, y).
Parameters:
x (int)The horizontal pixel position. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer.
y (int)the vertical pixel position. No validation is done on this value. The caller is responsible for ensuring that it is within the frame buffer.
value (float)The value to store in the channel at the specified position.

SetValues

#Since v6.0
public void SetValues(Rectangle rectangle, Size bufferResolution, PixelBuffer colorBuffer)
Set a pixel buffer
Parameters:
rectangle (Rectangle)
bufferResolution (Size)
colorBuffer (PixelBuffer)PixelBuffer to a color buffer of floats in RGBA format.

SetValuesFlipped

#Since v7.7
public void SetValuesFlipped(Rectangle rectangle, Size bufferResolution, PixelBuffer colorBuffer)
Set a pixel buffer y-flipped.
Parameters:
rectangle (Rectangle)
bufferResolution (Size)
colorBuffer (PixelBuffer)PixelBuffer to a color buffer of floats in RGBA format.