Blender V5.3
blender::image_engine::SpaceNodeAccessor Class Reference

#include <image_space_node.hh>

Inherits blender::image_engine::AbstractSpaceAccessor.

Public Member Functions

 SpaceNodeAccessor (SpaceNode *snode)
blender::Image * get_image (Main *bmain) override
ImageUser * get_image_user () override
ImBuf * acquire_image_buffer (blender::Image *image, void **lock) override
void release_buffer (blender::Image *image, ImBuf *ibuf, void *lock) override
void get_shader_parameters (ShaderParameters &r_shader_parameters, ImBuf *ibuf) override
bool use_tile_drawing () const override
 Is (wrap) repeat option enabled in the space.
bool use_display_window () const override
 Draw image with display window offsets.
float get_zoom () const override
 Gets the zoom factor of the space. A factor of 2 is a zoom-in by two times.
float get_aspect_ratio () const override
 Gets the aspect ratio of the image. The ratio is for the vertical axis.
float2 get_pan_offset () const override
 Gets the pan offset of the space in image pixel space.
Public Member Functions inherited from blender::image_engine::AbstractSpaceAccessor
virtual ~AbstractSpaceAccessor ()=default

Detailed Description

Definition at line 18 of file image_space_node.hh.

Constructor & Destructor Documentation

◆ SpaceNodeAccessor()

blender::image_engine::SpaceNodeAccessor::SpaceNodeAccessor ( SpaceNode * snode)
inline

Definition at line 22 of file image_space_node.hh.

Member Function Documentation

◆ acquire_image_buffer()

ImBuf * blender::image_engine::SpaceNodeAccessor::acquire_image_buffer ( blender::Image * image,
void ** lock )
inlineoverridevirtual

Acquire the image buffer of the image.

Parameters
imageImage to get the buffer from. Image is the same as returned from the get_image member.
lockpointer to a lock object.
Returns
Image buffer of the given image.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 34 of file image_space_node.hh.

References blender::BKE_image_acquire_ibuf_gpu(), and lock.

◆ get_aspect_ratio()

float blender::image_engine::SpaceNodeAccessor::get_aspect_ratio ( ) const
inlineoverridevirtual

Gets the aspect ratio of the image. The ratio is for the vertical axis.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 97 of file image_space_node.hh.

◆ get_image()

blender::Image * blender::image_engine::SpaceNodeAccessor::get_image ( Main * bmain)
inlineoverridevirtual

Return the active image of the space.

The returned image will be drawn in the space.

The return value is optional.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 24 of file image_space_node.hh.

References blender::BKE_image_ensure_viewer(), and blender::IMA_TYPE_COMPOSITE.

◆ get_image_user()

ImageUser * blender::image_engine::SpaceNodeAccessor::get_image_user ( )
inlineoverridevirtual

Return the ImageUser of the space.

The return value is optional.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 29 of file image_space_node.hh.

◆ get_pan_offset()

float2 blender::image_engine::SpaceNodeAccessor::get_pan_offset ( ) const
inlineoverridevirtual

Gets the pan offset of the space in image pixel space.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 102 of file image_space_node.hh.

◆ get_shader_parameters()

void blender::image_engine::SpaceNodeAccessor::get_shader_parameters ( ShaderParameters & r_shader_parameters,
ImBuf * image_buffer )
inlineoverridevirtual

Update the r_shader_parameters with space specific settings.

Only update the #ShaderParameters.flags and #ShaderParameters.shuffle. Other parameters are updated inside the image engine.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 44 of file image_space_node.hh.

References blender::image_engine::ShaderParameters::flags, IMAGE_DRAW_FLAG_APPLY_ALPHA, IMAGE_DRAW_FLAG_SHOW_ALPHA, IMAGE_DRAW_FLAG_SHUFFLING, blender::IMB_alpha_affects_rgb(), blender::image_engine::ShaderParameters::shuffle, blender::SNODE_SHOW_ALPHA, blender::SNODE_SHOW_B, blender::SNODE_SHOW_G, blender::SNODE_SHOW_R, and blender::SNODE_USE_ALPHA.

◆ get_zoom()

float blender::image_engine::SpaceNodeAccessor::get_zoom ( ) const
inlineoverridevirtual

Gets the zoom factor of the space. A factor of 2 is a zoom-in by two times.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 92 of file image_space_node.hh.

References blender::SpaceNode::zoom.

◆ release_buffer()

void blender::image_engine::SpaceNodeAccessor::release_buffer ( blender::Image * image,
ImBuf * image_buffer,
void * lock )
inlineoverridevirtual

Release a previous locked image from acquire_image_buffer.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 39 of file image_space_node.hh.

References blender::BKE_image_release_ibuf(), and lock.

◆ use_display_window()

bool blender::image_engine::SpaceNodeAccessor::use_display_window ( ) const
inlineoverridevirtual

Draw image with display window offsets.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 87 of file image_space_node.hh.

◆ use_tile_drawing()

bool blender::image_engine::SpaceNodeAccessor::use_tile_drawing ( ) const
inlineoverridevirtual

Is (wrap) repeat option enabled in the space.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 82 of file image_space_node.hh.


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