RenderWindow.Channel

References
public class RenderWindow.Channel : IDisposable

Properties

Height

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

Id

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

Width

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

Methods

AddValue

#Since v6.0
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.
public void AddValue(
x,
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,
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
The color to store in the channel at the specified position.
)

Clone

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

Dispose

#Since v5.0
public void Dispose()

Dispose

#
protected virtual void Dispose(
disposing
)

GetMinMaxValues

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

GetValue

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

GetValues

#Since v7.0
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.
public void GetValues(
rectangle,
stride,
componentOrder,
ref float[]
values
)

PixelSize

#Since v5.0
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).
public int PixelSize()
The size of a pixel.

SetValue

#Since v5.0
If x or y are out of range, the function will fail and may crash Rhino.
public void SetValue(
x,
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,
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
The color to store in the channel at the specified position.
)

SetValue

#Since v5.0
Assign value to a pixel at coordinate (x, y).
public void SetValue(
x,
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,
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
The value to store in the channel at the specified position.
)

SetValues

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

SetValuesFlipped

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