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

#include <image_space_image.hh>

Inherits blender::image_engine::AbstractSpaceAccessor.

Public Member Functions

 SpaceImageAccessor (SpaceImage *sima)
blender::Image * get_image (Main *) override
ImageUser * get_image_user () override
ImBuf * acquire_image_buffer (blender::Image *, void **lock) override
void release_buffer (blender::Image *, ImBuf *image_buffer, void *lock) override
void get_shader_parameters (ShaderParameters &r_shader_parameters, ImBuf *image_buffer) 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 20 of file image_space_image.hh.

Constructor & Destructor Documentation

◆ SpaceImageAccessor()

blender::image_engine::SpaceImageAccessor::SpaceImageAccessor ( SpaceImage * sima)
inline

Definition at line 24 of file image_space_image.hh.

Member Function Documentation

◆ acquire_image_buffer()

ImBuf * blender::image_engine::SpaceImageAccessor::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 36 of file image_space_image.hh.

References blender::ED_space_image_acquire_buffer(), and lock.

◆ get_aspect_ratio()

float blender::image_engine::SpaceImageAccessor::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 104 of file image_space_image.hh.

References blender::ED_space_image_get_aspect().

◆ get_image()

blender::Image * blender::image_engine::SpaceImageAccessor::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 26 of file image_space_image.hh.

References blender::ED_space_image().

◆ get_image_user()

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

Return the ImageUser of the space.

The return value is optional.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 31 of file image_space_image.hh.

◆ get_pan_offset()

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

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

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 111 of file image_space_image.hh.

◆ get_shader_parameters()

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

◆ get_zoom()

float blender::image_engine::SpaceImageAccessor::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 99 of file image_space_image.hh.

References blender::SpaceImage::zoom.

◆ release_buffer()

void blender::image_engine::SpaceImageAccessor::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 41 of file image_space_image.hh.

References blender::ED_space_image_release_buffer(), and lock.

◆ use_display_window()

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

Draw image with display window offsets.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 94 of file image_space_image.hh.

References blender::SI_MODE_VIEW.

◆ use_tile_drawing()

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

Is (wrap) repeat option enabled in the space.

Implements blender::image_engine::AbstractSpaceAccessor.

Definition at line 89 of file image_space_image.hh.

References blender::SI_DRAW_TILE.


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