Halide
Halide::OutputImageParam Class Reference

A handle on the output buffer of a pipeline. More...

#include <OutputImageParam.h>

Inherited by Halide::ImageParam.

Public Member Functions

 OutputImageParam ()
 Construct a null image parameter handle. More...
 
EXPORT const std::string & name () const
 Get the name of this Param. More...
 
EXPORT Type type () const
 Get the type of the image data this Param refers to. More...
 
EXPORT bool defined () const
 Is this parameter handle non-nullptr. More...
 
EXPORT Internal::Dimension dim (int i)
 Get a handle on one of the dimensions for the purposes of inspecting or constraining its min, extent, or stride. More...
 
EXPORT const Internal::Dimension dim (int i) const
 Get a handle on one of the dimensions for the purposes of inspecting its min, extent, or stride. More...
 
EXPORT int host_alignment () const
 Get the alignment of the host pointer in bytes. More...
 
EXPORT OutputImageParamset_host_alignment (int)
 Set the expected alignment of the host pointer in bytes. More...
 
EXPORT int dimensions () const
 Get the dimensionality of this image parameter. More...
 
EXPORT Expr left () const
 Get an expression giving the minimum coordinate in dimension 0, which by convention is the coordinate of the left edge of the image. More...
 
EXPORT Expr right () const
 Get an expression giving the maximum coordinate in dimension 0, which by convention is the coordinate of the right edge of the image. More...
 
EXPORT Expr top () const
 Get an expression giving the minimum coordinate in dimension 1, which by convention is the top of the image. More...
 
EXPORT Expr bottom () const
 Get an expression giving the maximum coordinate in dimension 1, which by convention is the bottom of the image. More...
 
EXPORT Expr width () const
 Get an expression giving the extent in dimension 0, which by convention is the width of the image. More...
 
EXPORT Expr height () const
 Get an expression giving the extent in dimension 1, which by convention is the height of the image. More...
 
EXPORT Expr channels () const
 Get an expression giving the extent in dimension 2, which by convention is the channel-count of the image. More...
 
EXPORT Internal::Parameter parameter () const
 Get at the internal parameter object representing this ImageParam. More...
 
EXPORT operator Argument () const
 Construct the appropriate argument matching this parameter, for the purpose of generating the right type signature when statically compiling halide pipelines. More...
 
EXPORT operator ExternFuncArgument () const
 Using a param as the argument to an external stage treats it as an Expr. More...
 

Protected Member Functions

void add_implicit_args_if_placeholder (std::vector< Expr > &args, Expr last_arg, int total_args, bool *placeholder_seen) const
 
EXPORT OutputImageParam (const Internal::Parameter &p, Argument::Kind k, Func f)
 Construct an OutputImageParam that wraps an Internal Parameter object. More...
 

Protected Attributes

Internal::Parameter param
 A reference-counted handle on the internal parameter object. More...
 
Argument::Kind kind
 Is this an input or an output? OutputImageParam is the base class for both. More...
 
Func func
 If Input: Func representation of the ImageParam. More...
 

Detailed Description

A handle on the output buffer of a pipeline.

Used to make static promises about the output size and stride.

Definition at line 20 of file OutputImageParam.h.

Constructor & Destructor Documentation

◆ OutputImageParam() [1/2]

EXPORT Halide::OutputImageParam::OutputImageParam ( const Internal::Parameter p,
Argument::Kind  k,
Func  f 
)
protected

Construct an OutputImageParam that wraps an Internal Parameter object.

◆ OutputImageParam() [2/2]

Halide::OutputImageParam::OutputImageParam ( )
inline

Construct a null image parameter handle.

Definition at line 46 of file OutputImageParam.h.

References bottom(), channels(), defined(), dim(), dimensions(), EXPORT, height(), host_alignment(), left(), name(), parameter(), right(), set_host_alignment(), top(), type(), and width().

Member Function Documentation

◆ add_implicit_args_if_placeholder()

void Halide::OutputImageParam::add_implicit_args_if_placeholder ( std::vector< Expr > &  args,
Expr  last_arg,
int  total_args,
bool *  placeholder_seen 
) const
protected

◆ name()

EXPORT const std::string& Halide::OutputImageParam::name ( ) const

Get the name of this Param.

Referenced by OutputImageParam().

◆ type()

EXPORT Type Halide::OutputImageParam::type ( ) const

Get the type of the image data this Param refers to.

Referenced by OutputImageParam().

◆ defined()

EXPORT bool Halide::OutputImageParam::defined ( ) const

Is this parameter handle non-nullptr.

Referenced by OutputImageParam().

◆ dim() [1/2]

EXPORT Internal::Dimension Halide::OutputImageParam::dim ( int  i)

Get a handle on one of the dimensions for the purposes of inspecting or constraining its min, extent, or stride.

Referenced by OutputImageParam().

◆ dim() [2/2]

EXPORT const Internal::Dimension Halide::OutputImageParam::dim ( int  i) const

Get a handle on one of the dimensions for the purposes of inspecting its min, extent, or stride.

◆ host_alignment()

EXPORT int Halide::OutputImageParam::host_alignment ( ) const

Get the alignment of the host pointer in bytes.

Defaults to the size of type.

Referenced by OutputImageParam().

◆ set_host_alignment()

EXPORT OutputImageParam& Halide::OutputImageParam::set_host_alignment ( int  )

Set the expected alignment of the host pointer in bytes.

Referenced by OutputImageParam().

◆ dimensions()

EXPORT int Halide::OutputImageParam::dimensions ( ) const

Get the dimensionality of this image parameter.

Referenced by OutputImageParam().

◆ left()

EXPORT Expr Halide::OutputImageParam::left ( ) const

Get an expression giving the minimum coordinate in dimension 0, which by convention is the coordinate of the left edge of the image.

Referenced by OutputImageParam().

◆ right()

EXPORT Expr Halide::OutputImageParam::right ( ) const

Get an expression giving the maximum coordinate in dimension 0, which by convention is the coordinate of the right edge of the image.

Referenced by OutputImageParam().

◆ top()

EXPORT Expr Halide::OutputImageParam::top ( ) const

Get an expression giving the minimum coordinate in dimension 1, which by convention is the top of the image.

Referenced by OutputImageParam().

◆ bottom()

EXPORT Expr Halide::OutputImageParam::bottom ( ) const

Get an expression giving the maximum coordinate in dimension 1, which by convention is the bottom of the image.

Referenced by OutputImageParam().

◆ width()

EXPORT Expr Halide::OutputImageParam::width ( ) const

Get an expression giving the extent in dimension 0, which by convention is the width of the image.

Referenced by OutputImageParam().

◆ height()

EXPORT Expr Halide::OutputImageParam::height ( ) const

Get an expression giving the extent in dimension 1, which by convention is the height of the image.

Referenced by OutputImageParam().

◆ channels()

EXPORT Expr Halide::OutputImageParam::channels ( ) const

Get an expression giving the extent in dimension 2, which by convention is the channel-count of the image.

Referenced by OutputImageParam().

◆ parameter()

EXPORT Internal::Parameter Halide::OutputImageParam::parameter ( ) const

Get at the internal parameter object representing this ImageParam.

Referenced by OutputImageParam().

◆ operator Argument()

EXPORT Halide::OutputImageParam::operator Argument ( ) const

Construct the appropriate argument matching this parameter, for the purpose of generating the right type signature when statically compiling halide pipelines.

◆ operator ExternFuncArgument()

EXPORT Halide::OutputImageParam::operator ExternFuncArgument ( ) const

Using a param as the argument to an external stage treats it as an Expr.

Member Data Documentation

◆ param

Internal::Parameter Halide::OutputImageParam::param
protected

A reference-counted handle on the internal parameter object.

Definition at line 25 of file OutputImageParam.h.

◆ kind

Argument::Kind Halide::OutputImageParam::kind
protected

Is this an input or an output? OutputImageParam is the base class for both.

Definition at line 28 of file OutputImageParam.h.

◆ func

Func Halide::OutputImageParam::func
protected

If Input: Func representation of the ImageParam.

If Output: Func that creates this OutputImageParam.

Definition at line 33 of file OutputImageParam.h.


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