VTK  9.1.0
Public Member Functions | List of all members
vtkSynchronizedRenderers::vtkRawImage Struct Reference

vtkRawImage can be used to make it easier to deal with images for compositing/communicating over client-server etc. More...

#include <vtkSynchronizedRenderers.h>

Public Member Functions

 vtkRawImage ()
 
void Resize (int dx, int dy, int numcomps)
 
void Initialize (int dx, int dy, vtkUnsignedCharArray *data)
 Create the buffer from an image data. More...
 
void MarkValid ()
 
void MarkInValid ()
 
bool IsValid ()
 
int GetWidth ()
 
int GetHeight ()
 
vtkUnsignedCharArrayGetRawPtr ()
 
bool PushToViewport (vtkRenderer *renderer, bool blend=true)
 Pushes the image to the viewport. More...
 
bool PushToFrameBuffer (vtkRenderer *ren, bool blend=true)
 This is a raw version of PushToViewport() that assumes that the glViewport() has already been setup externally. More...
 
bool Capture (vtkRenderer *)
 
void SaveAsPNG (VTK_FILEPATH const char *filename)
 

Detailed Description

vtkRawImage can be used to make it easier to deal with images for compositing/communicating over client-server etc.

Definition at line 168 of file vtkSynchronizedRenderers.h.

Constructor & Destructor Documentation

◆ vtkRawImage()

vtkSynchronizedRenderers::vtkRawImage::vtkRawImage ( )
inline

Definition at line 171 of file vtkSynchronizedRenderers.h.

Member Function Documentation

◆ Resize()

void vtkSynchronizedRenderers::vtkRawImage::Resize ( int  dx,
int  dy,
int  numcomps 
)
inline

Definition at line 178 of file vtkSynchronizedRenderers.h.

◆ Initialize()

void vtkSynchronizedRenderers::vtkRawImage::Initialize ( int  dx,
int  dy,
vtkUnsignedCharArray data 
)

Create the buffer from an image data.

◆ MarkValid()

void vtkSynchronizedRenderers::vtkRawImage::MarkValid ( )
inline

Definition at line 189 of file vtkSynchronizedRenderers.h.

◆ MarkInValid()

void vtkSynchronizedRenderers::vtkRawImage::MarkInValid ( )
inline

Definition at line 190 of file vtkSynchronizedRenderers.h.

◆ IsValid()

bool vtkSynchronizedRenderers::vtkRawImage::IsValid ( )
inline

Definition at line 192 of file vtkSynchronizedRenderers.h.

◆ GetWidth()

int vtkSynchronizedRenderers::vtkRawImage::GetWidth ( )
inline

Definition at line 193 of file vtkSynchronizedRenderers.h.

◆ GetHeight()

int vtkSynchronizedRenderers::vtkRawImage::GetHeight ( )
inline

Definition at line 194 of file vtkSynchronizedRenderers.h.

◆ GetRawPtr()

vtkUnsignedCharArray * vtkSynchronizedRenderers::vtkRawImage::GetRawPtr ( )
inline

Definition at line 195 of file vtkSynchronizedRenderers.h.

◆ PushToViewport()

bool vtkSynchronizedRenderers::vtkRawImage::PushToViewport ( vtkRenderer renderer,
bool  blend = true 
)

Pushes the image to the viewport.

The OpenGL viewport and scissor region is setup using the viewport defined by the renderer.

If blend is true (default), the image will be blended onto to the existing background, else it will replace it.

◆ PushToFrameBuffer()

bool vtkSynchronizedRenderers::vtkRawImage::PushToFrameBuffer ( vtkRenderer ren,
bool  blend = true 
)

This is a raw version of PushToViewport() that assumes that the glViewport() has already been setup externally.

If blend is true (default), the image will be blended onto to the existing background, else it will replace it.

◆ Capture()

bool vtkSynchronizedRenderers::vtkRawImage::Capture ( vtkRenderer )

◆ SaveAsPNG()

void vtkSynchronizedRenderers::vtkRawImage::SaveAsPNG ( VTK_FILEPATH const char *  filename)

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