view release on metacpan or  search on metacpan

lib/AntTweakBar.pm  view on Meta::CPAN

    'all' => [ qw(init window_size terminate), @constants ],
    'constants' => \@constants,
);

our @EXPORT_OK = ( @{ $EXPORT_TAGS{'all'} } );

our @EXPORT = qw(

);

our $VERSION = '0.05';

=head1 NAME

AntTweakBar - Perl bindings for AntTweakBar

=head1 SYNOPSIS

  use AntTweakBar qw/:all/;
  use SDL::Events;

  # Setup part: link AntTweakBar with your OpenGL/SDL system

  AntTweakBar::init(TW_OPENGL);
  AntTweakBar::window_size($width, $height);

  # in your main rendering routine
  sub display {
    AntTweakBar::draw;
  }

  sub process_events {
    SDL::Events::pump_events;
    my $event = $self->sdl_event;
    while (SDL::Events::poll_event($event)) {
        ...;
        AntTweakBar::eventSDL($event);
    }
  }


  # define bars with variables
  my $bar = AntTweakBar->new(
    "TweakBar & Perl",
    size  => '200 400',
    color => '96 216 224'
  );
  my $enabled = 0;
  $bar->add_variable(
    mode       => 'rw',
    name       => "Enabled",
    type       => 'bool',
    value      => \$enabled
);


=head1 DESCRIPTION

=for HTML
<p>
  <img src="https://raw.githubusercontent.com/PerlGameDev/AntTweakBar/master/eg/available-properties.png" style="max-width:100%;">
  <img src="https://raw.githubusercontent.com/PerlGameDev/AntTweakBar/master/eg/simple-glut.gif" style="max-width:100%;">
</p>


AntTweakBar (see L<http://anttweakbar.sourceforge.net/>) is nice tiny
GUI library for OpenGL/SDL/DirectX applications.

If you are in hurry to evaluate it then intall AntTweakBar and try
examples from C<eg> directory within the distribution.

To display AntTweakBar in your OpenGL/SDL application you should do the
following:

=over

=item intialize AntTweakBar(s):

  AntTweakBar::init(TW_OPENGL);
  AntTweakBar::window_size($width, $height);

=item draw AntTweakBar(s):

  AntTweakBar::draw;

=item let AntTweakBar(s) respond to user interactions:

  AntTweakBar::eventSDL($event);

=item create AntTweakBar instance(s)

  my $bar = AntTweakBar->new("TweakBar");

=item add variables into the $bar

  my $value = 3.14;
  $bar->add_variable(
    mode       => 'rw',
    name       => "Enabled",
    type       => 'integer',
    value      => \$value
  );

=back

See working examples in the C<eg> directoctory within the distribution.

=head2 EXPORT

Constants only


=head1 CONSTANTS

The following constants let AntTweakBar know which graphic system do
you use, to know how to render itself

=head2 TW_OPENGL

Render using plain old OpenGL